@promptbook/cli 0.62.2 → 0.63.0-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 (843) hide show
  1. package/esm/index.es.js +7900 -7710
  2. package/esm/index.es.js.map +1 -1
  3. package/esm/typings/promptbook-collection/index.d.ts +252 -252
  4. package/esm/typings/src/_packages/anthropic-claude.index.d.ts +6 -5
  5. package/esm/typings/src/_packages/azure-openai.index.d.ts +6 -4
  6. package/esm/typings/src/_packages/browser.index.d.ts +6 -0
  7. package/esm/typings/src/_packages/cli.index.d.ts +4 -10
  8. package/esm/typings/src/_packages/core.index.d.ts +124 -50
  9. package/esm/typings/src/_packages/execute-javascript.index.d.ts +8 -48
  10. package/esm/typings/src/_packages/fake-llm.index.d.ts +6 -7
  11. package/esm/typings/src/_packages/langtail.index.d.ts +6 -4
  12. package/esm/typings/src/_packages/markdown-utils.index.d.ts +36 -17
  13. package/esm/typings/src/_packages/node.index.d.ts +8 -5
  14. package/esm/typings/src/_packages/openai.index.d.ts +8 -5
  15. package/esm/typings/src/_packages/remote-client.index.d.ts +8 -5
  16. package/esm/typings/src/_packages/remote-server.index.d.ts +6 -4
  17. package/esm/typings/src/_packages/types.index.d.ts +462 -42
  18. package/esm/typings/src/_packages/utils.index.d.ts +130 -77
  19. package/esm/typings/src/cli/cli-commands/hello.d.ts +10 -10
  20. package/esm/typings/src/cli/cli-commands/make.d.ts +10 -10
  21. package/esm/typings/src/cli/cli-commands/prettify.d.ts +10 -10
  22. package/esm/typings/src/cli/main.d.ts +12 -0
  23. package/esm/typings/src/cli/promptbookCli.d.ts +10 -10
  24. package/esm/typings/src/collection/PipelineCollection.d.ts +25 -25
  25. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +38 -38
  26. package/esm/typings/src/collection/collectionToJson.d.ts +13 -11
  27. package/esm/typings/src/collection/collectionToJson.test.d.ts +7 -7
  28. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +48 -47
  29. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.test.d.ts +1 -1
  30. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +13 -12
  31. package/esm/typings/src/collection/constructors/createCollectionFromJson.test.d.ts +1 -1
  32. package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +23 -22
  33. package/esm/typings/src/collection/constructors/createCollectionFromPromise.test.d.ts +1 -1
  34. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +29 -29
  35. package/esm/typings/src/collection/constructors/createSubcollection.d.ts +13 -12
  36. package/esm/typings/src/commands/BLOCK/BlockCommand.d.ts +11 -11
  37. package/esm/typings/src/commands/BLOCK/BlockTypes.d.ts +15 -13
  38. package/esm/typings/src/commands/BLOCK/blockCommand.test.d.ts +1 -1
  39. package/esm/typings/src/commands/BLOCK/blockCommandParser.d.ts +9 -9
  40. package/esm/typings/src/commands/EXPECT/ExpectAmountCommand.d.ts +14 -14
  41. package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts +9 -9
  42. package/esm/typings/src/commands/EXPECT/ExpectFormatCommand.d.ts +7 -7
  43. package/esm/typings/src/commands/EXPECT/expectCommand.test.d.ts +1 -1
  44. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +9 -9
  45. package/esm/typings/src/commands/JOKER/JokerCommand.d.ts +11 -11
  46. package/esm/typings/src/commands/JOKER/jokerCommand.test.d.ts +1 -1
  47. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +9 -9
  48. package/esm/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +11 -11
  49. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts +1 -1
  50. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +9 -9
  51. package/esm/typings/src/commands/MODEL/ModelCommand.d.ts +13 -13
  52. package/esm/typings/src/commands/MODEL/modelCommand.test.d.ts +1 -1
  53. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +9 -9
  54. package/esm/typings/src/commands/PARAMETER/ParameterCommand.d.ts +15 -15
  55. package/esm/typings/src/commands/PARAMETER/parameterCommand.test.d.ts +1 -1
  56. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +9 -9
  57. package/esm/typings/src/commands/PERSONA/PersonaCommand.d.ts +13 -13
  58. package/esm/typings/src/commands/PERSONA/personaCommand.test.d.ts +1 -1
  59. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +9 -9
  60. package/esm/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts +11 -11
  61. package/esm/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts +1 -1
  62. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +9 -9
  63. package/esm/typings/src/commands/PROMPTBOOK_VERSION/PromptbookVersionCommand.d.ts +11 -11
  64. package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommand.test.d.ts +1 -1
  65. package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +9 -9
  66. package/esm/typings/src/commands/URL/UrlCommand.d.ts +10 -10
  67. package/esm/typings/src/commands/URL/urlCommand.test.d.ts +1 -1
  68. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +9 -9
  69. package/esm/typings/src/commands/X_ACTION/ActionCommand.d.ts +9 -9
  70. package/esm/typings/src/commands/X_ACTION/actionCommand.test.d.ts +1 -1
  71. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +9 -9
  72. package/esm/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +9 -9
  73. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts +1 -1
  74. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +9 -9
  75. package/esm/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +10 -10
  76. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts +1 -1
  77. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +13 -13
  78. package/esm/typings/src/commands/_common/parseCommand.d.ts +12 -12
  79. package/esm/typings/src/commands/_common/parseCommand.test.d.ts +1 -1
  80. package/esm/typings/src/commands/_common/types/Command.d.ts +6 -6
  81. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +64 -64
  82. package/esm/typings/src/commands/_common/types/CommandUsagePlaces.d.ts +9 -9
  83. package/esm/typings/src/commands/index.d.ts +4 -4
  84. package/esm/typings/src/config.d.ts +87 -61
  85. package/esm/typings/src/config.test.d.ts +4 -4
  86. package/esm/typings/src/conversion/pipelineJsonToString.d.ts +16 -15
  87. package/esm/typings/src/conversion/pipelineStringToJson.d.ts +38 -35
  88. package/esm/typings/src/conversion/pipelineStringToJson.test.d.ts +1 -1
  89. package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +29 -28
  90. package/esm/typings/src/conversion/pipelineStringToJsonSync.test.d.ts +1 -1
  91. package/esm/typings/src/conversion/prettify/PrettifyOptions.d.ts +13 -13
  92. package/esm/typings/src/conversion/prettify/prettifyPipelineString.d.ts +12 -10
  93. package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +27 -25
  94. package/esm/typings/src/conversion/utils/extractParameterNamesFromPromptTemplate.d.ts +14 -13
  95. package/esm/typings/src/conversion/utils/extractParameterNamesFromPromptTemplate.test.d.ts +1 -1
  96. package/esm/typings/src/conversion/utils/extractVariables.d.ts +14 -13
  97. package/esm/typings/src/conversion/utils/extractVariables.test.d.ts +1 -1
  98. package/esm/typings/src/conversion/utils/renameParameter.d.ts +26 -25
  99. package/esm/typings/src/conversion/utils/renameParameter.test.d.ts +1 -1
  100. package/esm/typings/src/conversion/utils/stringifyPipelineJson.d.ts +16 -14
  101. package/esm/typings/src/conversion/utils/stringifyPipelineJson.test.d.ts +1 -1
  102. package/esm/typings/src/conversion/utils/titleToName.d.ts +9 -4
  103. package/esm/typings/src/conversion/utils/titleToName.test.d.ts +1 -1
  104. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +22 -22
  105. package/esm/typings/src/conversion/validation/pipelineStringToJson-syntaxErrors.test.d.ts +1 -1
  106. package/esm/typings/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +4 -4
  107. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +37 -36
  108. package/esm/typings/src/conversion/validation/validatePipeline.test.d.ts +1 -1
  109. package/esm/typings/src/errors/CollectionError.d.ts +9 -7
  110. package/esm/typings/src/errors/EnvironmentMismatchError.d.ts +9 -7
  111. package/esm/typings/src/errors/LimitReachedError.d.ts +9 -7
  112. package/esm/typings/src/errors/NotFoundError.d.ts +9 -7
  113. package/esm/typings/src/errors/NotYetImplementedError.d.ts +9 -7
  114. package/esm/typings/src/errors/ParsingError.d.ts +9 -7
  115. package/esm/typings/src/errors/PipelineExecutionError.d.ts +9 -7
  116. package/esm/typings/src/errors/PipelineLogicError.d.ts +9 -7
  117. package/esm/typings/src/errors/ReferenceError.d.ts +9 -7
  118. package/esm/typings/src/errors/UnexpectedError.d.ts +9 -7
  119. package/esm/typings/src/errors/VersionMismatchError.d.ts +10 -8
  120. package/esm/typings/src/errors/_ExpectError.d.ts +10 -10
  121. package/esm/typings/src/execution/CommonExecutionToolsOptions.d.ts +10 -10
  122. package/esm/typings/src/execution/EmbeddingVector.d.ts +8 -8
  123. package/esm/typings/src/execution/ExecutionTools.d.ts +33 -33
  124. package/esm/typings/src/execution/LlmExecutionTools.d.ts +72 -72
  125. package/esm/typings/src/execution/PipelineExecutor.d.ts +64 -64
  126. package/esm/typings/src/execution/PromptResult.d.ts +99 -99
  127. package/esm/typings/src/execution/PromptResultUsage.d.ts +29 -29
  128. package/esm/typings/src/execution/ScriptExecutionTools.d.ts +39 -39
  129. package/esm/typings/src/execution/UncertainNumber.d.ts +18 -18
  130. package/esm/typings/src/execution/UserInterfaceTools.d.ts +46 -46
  131. package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +12 -11
  132. package/esm/typings/src/execution/createPipelineExecutor.d.ts +71 -70
  133. package/esm/typings/src/execution/embeddingVectorToString.d.ts +7 -5
  134. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +4 -4
  135. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +9 -9
  136. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +5 -5
  137. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +11 -11
  138. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +4 -4
  139. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +7 -7
  140. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts +1 -1
  141. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +5 -5
  142. package/esm/typings/src/execution/utils/addUsage.d.ts +65 -63
  143. package/esm/typings/src/execution/utils/addUsage.test.d.ts +1 -1
  144. package/esm/typings/src/execution/utils/checkExpectations.d.ts +27 -25
  145. package/esm/typings/src/execution/utils/checkExpectations.test.d.ts +1 -1
  146. package/esm/typings/src/execution/utils/computeUsageCounts.d.ts +10 -10
  147. package/esm/typings/src/execution/utils/forEachAsync.d.ts +19 -18
  148. package/esm/typings/src/execution/utils/uncertainNumber.d.ts +9 -9
  149. package/esm/typings/src/execution/utils/usageToHuman.d.ts +17 -15
  150. package/esm/typings/src/execution/utils/usageToHuman.test.d.ts +1 -1
  151. package/esm/typings/src/execution/utils/usageToWorktime.d.ts +12 -10
  152. package/esm/typings/src/execution/utils/usageToWorktime.test.d.ts +1 -1
  153. package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts +6 -6
  154. package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts +6 -6
  155. package/esm/typings/src/formats/_common/FormatDefinition.d.ts +70 -69
  156. package/esm/typings/src/formats/csv/ListFormatDefinition.d.ts +12 -12
  157. package/esm/typings/src/formats/index.d.ts +4 -4
  158. package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts +16 -16
  159. package/esm/typings/src/formats/json/utils/isValidJsonString.d.ts +6 -4
  160. package/esm/typings/src/formats/json/utils/isValidJsonString.test.d.ts +1 -1
  161. package/esm/typings/src/formats/list/ListFormatDefinition.d.ts +14 -14
  162. package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts +16 -16
  163. package/esm/typings/src/knowledge/dialogs/callback/CallbackInterfaceTools.d.ts +17 -15
  164. package/esm/typings/src/knowledge/dialogs/callback/CallbackInterfaceToolsOptions.d.ts +14 -12
  165. package/esm/typings/src/knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +22 -20
  166. package/esm/typings/src/knowledge/dialogs/user-interface-execution-tools.test.d.ts +1 -1
  167. package/esm/typings/src/knowledge/prepare-knowledge/_common/Scraper.d.ts +37 -27
  168. package/esm/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.d.ts +18 -18
  169. package/esm/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.test.d.ts +1 -1
  170. package/esm/typings/src/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts +2 -2
  171. package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +14 -12
  172. package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts +4 -4
  173. package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +13 -13
  174. package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts +1 -1
  175. package/esm/typings/src/llm-providers/_common/createLlmToolsFromEnv.d.ts +37 -34
  176. package/esm/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts +20 -20
  177. package/esm/typings/src/llm-providers/_common/getLlmToolsForTestingAndScriptsAndPlayground.d.ts +21 -21
  178. package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts +29 -29
  179. package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +16 -16
  180. package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts +19 -19
  181. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +15 -15
  182. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/countTotalUsage.d.ts +17 -17
  183. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +36 -35
  184. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +52 -50
  185. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +12 -11
  186. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +22 -22
  187. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +6 -6
  188. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +50 -48
  189. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +36 -35
  190. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +5 -5
  191. package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +17 -15
  192. package/esm/typings/src/llm-providers/langtail/LangtailExecutionToolsOptions.d.ts +13 -11
  193. package/esm/typings/src/llm-providers/langtail/playground/playground.d.ts +2 -2
  194. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +36 -34
  195. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +40 -38
  196. package/esm/typings/src/llm-providers/mocked/fakeTextToExpectations.d.ts +14 -14
  197. package/esm/typings/src/llm-providers/mocked/test/fakeTextToExpectations.test.d.ts +1 -1
  198. package/esm/typings/src/llm-providers/mocked/test/faked-completion.test.d.ts +1 -1
  199. package/esm/typings/src/llm-providers/mocked/test/joker.test.d.ts +4 -4
  200. package/esm/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts +5 -5
  201. package/esm/typings/src/llm-providers/mocked/test/mocked-completion.test.d.ts +4 -4
  202. package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +54 -54
  203. package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +21 -19
  204. package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts +2 -2
  205. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +68 -66
  206. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +20 -18
  207. package/esm/typings/src/llm-providers/openai/computeOpenaiUsage.d.ts +14 -14
  208. package/esm/typings/src/llm-providers/openai/computeOpenaiUsage.test.d.ts +1 -1
  209. package/esm/typings/src/llm-providers/openai/computeUsage.d.ts +16 -16
  210. package/esm/typings/src/llm-providers/openai/computeUsage.test.d.ts +1 -1
  211. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +29 -28
  212. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +5 -5
  213. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +56 -55
  214. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionToolsOptions.d.ts +26 -24
  215. package/esm/typings/src/llm-providers/remote/interfaces/Promptbook_Server_Error.d.ts +11 -11
  216. package/esm/typings/src/llm-providers/remote/interfaces/Promptbook_Server_Progress.d.ts +12 -12
  217. package/esm/typings/src/llm-providers/remote/interfaces/Promptbook_Server_Request.d.ts +17 -17
  218. package/esm/typings/src/llm-providers/remote/interfaces/Promptbook_Server_Response.d.ts +12 -12
  219. package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts +37 -31
  220. package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts +21 -20
  221. package/esm/typings/src/personas/preparePersona.d.ts +15 -15
  222. package/esm/typings/src/personas/preparePersona.test.d.ts +1 -1
  223. package/esm/typings/src/postprocessing/utils/extractBlock.d.ts +17 -12
  224. package/esm/typings/src/prepare/PrepareOptions.d.ts +22 -22
  225. package/esm/typings/src/prepare/isPipelinePrepared.d.ts +15 -14
  226. package/esm/typings/src/prepare/isPipelinePrepared.test.d.ts +1 -1
  227. package/esm/typings/src/prepare/preparePipeline.d.ts +16 -16
  228. package/esm/typings/src/prepare/prepareTemplates.d.ts +32 -31
  229. package/esm/typings/src/prepare/unpreparePipeline.d.ts +12 -11
  230. package/esm/typings/src/scripting/_test/custom-function-async.test.ts.test.d.ts +1 -1
  231. package/esm/typings/src/scripting/_test/custom-function-missing.test.d.ts +1 -1
  232. package/esm/typings/src/scripting/_test/custom-function-with-dependencies.test.d.ts +1 -1
  233. package/esm/typings/src/scripting/_test/custom-function.test.d.ts +1 -1
  234. package/esm/typings/src/scripting/_test/postprocessing.test.d.ts +1 -1
  235. package/esm/typings/src/scripting/_test/script-execution-errors.test.d.ts +1 -1
  236. package/esm/typings/src/scripting/_test/script-execution-tools.test.d.ts +1 -1
  237. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +22 -20
  238. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -4
  239. package/esm/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts +8 -7
  240. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +26 -26
  241. package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts +51 -0
  242. package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +12 -12
  243. package/esm/typings/src/scripting/javascript/utils/unknownToString.d.ts +8 -8
  244. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +16 -16
  245. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +16 -16
  246. package/esm/typings/src/storage/_common/PromptbookStorage.d.ts +24 -25
  247. package/esm/typings/src/storage/_common/PromptbookStorage.test-type.d.ts +5 -5
  248. package/esm/typings/src/storage/files-storage/FilesStorage.d.ts +31 -30
  249. package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts +10 -13
  250. package/esm/typings/src/storage/files-storage/utils/nameToSubfolderPath.d.ts +7 -7
  251. package/esm/typings/src/storage/files-storage/utils/nameToSubfolderPath.test.d.ts +1 -1
  252. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +10 -9
  253. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +10 -9
  254. package/esm/typings/src/storage/memory/MemoryStorage.d.ts +33 -34
  255. package/esm/typings/src/storage/utils/PrefixStorage.d.ts +25 -26
  256. package/esm/typings/src/storage/utils/makePromptbookStorageFromWebStorage.d.ts +11 -11
  257. package/esm/typings/src/types/Arrayable.d.ts +10 -10
  258. package/esm/typings/src/types/ModelRequirements.d.ts +102 -103
  259. package/esm/typings/src/types/ModelVariant.d.ts +14 -14
  260. package/esm/typings/src/types/PipelineJson/Expectations.d.ts +32 -32
  261. package/esm/typings/src/types/PipelineJson/KnowledgePieceJson.d.ts +70 -70
  262. package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts +27 -27
  263. package/esm/typings/src/types/PipelineJson/LlmTemplateJson.d.ts +25 -25
  264. package/esm/typings/src/types/PipelineJson/PersonaJson.d.ts +41 -41
  265. package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +87 -87
  266. package/esm/typings/src/types/PipelineJson/PreparationJson.d.ts +22 -22
  267. package/esm/typings/src/types/PipelineJson/PromptDialogJson.d.ts +13 -13
  268. package/esm/typings/src/types/PipelineJson/PromptTemplateJson.d.ts +13 -13
  269. package/esm/typings/src/types/PipelineJson/PromptTemplateJsonCommon.d.ts +96 -96
  270. package/esm/typings/src/types/PipelineJson/PromptTemplateParameterJson.d.ts +36 -36
  271. package/esm/typings/src/types/PipelineJson/ScriptJson.d.ts +19 -19
  272. package/esm/typings/src/types/PipelineJson/SimpleTemplateJson.d.ts +12 -12
  273. package/esm/typings/src/types/PipelineString.d.ts +12 -12
  274. package/esm/typings/src/types/Prompt.d.ts +108 -109
  275. package/esm/typings/src/types/ScriptLanguage.d.ts +9 -9
  276. package/esm/typings/src/types/TaskProgress.d.ts +43 -43
  277. package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts +58 -58
  278. package/esm/typings/src/types/execution-report/ExecutionReportString.d.ts +16 -16
  279. package/esm/typings/src/types/execution-report/ExecutionReportStringOptions.d.ts +25 -21
  280. package/esm/typings/src/types/execution-report/config.d.ts +8 -8
  281. package/esm/typings/src/types/execution-report/countWorkingDuration.d.ts +7 -7
  282. package/esm/typings/src/types/execution-report/countWorkingDuration.test.d.ts +1 -1
  283. package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts +13 -11
  284. package/esm/typings/src/types/typeAliasEmoji.d.ts +9 -9
  285. package/esm/typings/src/types/typeAliases.d.ts +586 -579
  286. package/esm/typings/src/utils/FromtoItems.d.ts +19 -19
  287. package/esm/typings/src/utils/arrayableToArray.d.ts +11 -11
  288. package/esm/typings/src/utils/arrayableToArray.test.d.ts +1 -1
  289. package/esm/typings/src/utils/currentDate.d.ts +8 -7
  290. package/esm/typings/src/utils/deepClone.d.ts +10 -9
  291. package/esm/typings/src/utils/deepFreeze.d.ts +22 -22
  292. package/esm/typings/src/utils/emojis.d.ts +23 -23
  293. package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts +7 -5
  294. package/esm/typings/src/utils/expectation-counters/countCharacters.test.d.ts +1 -1
  295. package/esm/typings/src/utils/expectation-counters/countLines.d.ts +7 -5
  296. package/esm/typings/src/utils/expectation-counters/countLines.test.d.ts +1 -1
  297. package/esm/typings/src/utils/expectation-counters/countPages.d.ts +7 -5
  298. package/esm/typings/src/utils/expectation-counters/countPages.test.d.ts +1 -1
  299. package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts +7 -5
  300. package/esm/typings/src/utils/expectation-counters/countParagraphs.test.d.ts +1 -1
  301. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +13 -9
  302. package/esm/typings/src/utils/expectation-counters/countSentences.test.d.ts +1 -1
  303. package/esm/typings/src/utils/expectation-counters/countWords.d.ts +7 -5
  304. package/esm/typings/src/utils/expectation-counters/countWords.test.d.ts +1 -1
  305. package/esm/typings/src/utils/expectation-counters/index.d.ts +8 -6
  306. package/esm/typings/src/utils/extractParameterNames.d.ts +10 -9
  307. package/esm/typings/src/utils/extractParameterNames.test.d.ts +1 -1
  308. package/esm/typings/src/utils/formatNumber.d.ts +6 -6
  309. package/esm/typings/src/utils/formatNumber.test.d.ts +1 -1
  310. package/esm/typings/src/utils/getCurrentIsoDate.d.ts +7 -7
  311. package/esm/typings/src/utils/isRunningInWhatever.d.ts +18 -15
  312. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +14 -11
  313. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.test.d.ts +1 -1
  314. package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts +38 -38
  315. package/esm/typings/src/utils/markdown/createMarkdownChart.test.d.ts +1 -1
  316. package/esm/typings/src/utils/markdown/createMarkdownTable.d.ts +11 -8
  317. package/esm/typings/src/utils/markdown/createMarkdownTable.test.d.ts +1 -1
  318. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.d.ts +11 -6
  319. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.test.d.ts +1 -1
  320. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts +1 -1
  321. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +34 -34
  322. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts +1 -1
  323. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +15 -14
  324. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts +1 -1
  325. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +20 -19
  326. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.test.d.ts +1 -1
  327. package/esm/typings/src/utils/markdown/flattenMarkdown.d.ts +17 -14
  328. package/esm/typings/src/utils/markdown/flattenMarkdown.test.d.ts +1 -1
  329. package/esm/typings/src/utils/markdown/parseMarkdownSection.d.ts +34 -30
  330. package/esm/typings/src/utils/markdown/parseMarkdownSection.test.d.ts +1 -1
  331. package/esm/typings/src/utils/markdown/prettifyMarkdown.d.ts +9 -9
  332. package/esm/typings/src/utils/markdown/prettifyMarkdown.test.d.ts +1 -1
  333. package/esm/typings/src/utils/markdown/removeContentComments.d.ts +10 -9
  334. package/esm/typings/src/utils/markdown/removeContentComments.test.d.ts +1 -1
  335. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.d.ts +9 -8
  336. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.test.d.ts +1 -1
  337. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +15 -12
  338. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts +1 -1
  339. package/esm/typings/src/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts +12 -10
  340. package/esm/typings/src/utils/normalization/IKeywords.d.ts +21 -18
  341. package/esm/typings/src/utils/normalization/capitalize.d.ts +6 -5
  342. package/esm/typings/src/utils/normalization/capitalize.test.d.ts +1 -1
  343. package/esm/typings/src/utils/normalization/decapitalize.d.ts +6 -5
  344. package/esm/typings/src/utils/normalization/decapitalize.test.d.ts +1 -1
  345. package/esm/typings/src/utils/normalization/isValidKeyword.d.ts +10 -8
  346. package/esm/typings/src/utils/normalization/isValidKeyword.test.d.ts +1 -1
  347. package/esm/typings/src/utils/normalization/nameToUriPart.d.ts +9 -1
  348. package/esm/typings/src/utils/normalization/nameToUriPart.test.d.ts +1 -1
  349. package/esm/typings/src/utils/normalization/nameToUriParts.d.ts +9 -1
  350. package/esm/typings/src/utils/normalization/nameToUriParts.test.d.ts +1 -1
  351. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts +18 -8
  352. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.test.d.ts +1 -1
  353. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts +17 -8
  354. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.test.d.ts +1 -1
  355. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +26 -16
  356. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts +1 -1
  357. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.d.ts +22 -11
  358. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.test.d.ts +1 -1
  359. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts +17 -8
  360. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.test.d.ts +1 -1
  361. package/esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts +4 -4
  362. package/esm/typings/src/utils/normalization/normalizeWhitespaces.test.d.ts +1 -1
  363. package/esm/typings/src/utils/normalization/parseKeywords.d.ts +16 -15
  364. package/esm/typings/src/utils/normalization/parseKeywords.test.d.ts +1 -1
  365. package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +9 -8
  366. package/esm/typings/src/utils/normalization/parseKeywordsFromString.test.d.ts +1 -1
  367. package/esm/typings/src/utils/normalization/removeDiacritics.d.ts +11 -4
  368. package/esm/typings/src/utils/normalization/removeDiacritics.test.d.ts +1 -1
  369. package/esm/typings/src/utils/normalization/searchKeywords.d.ts +10 -5
  370. package/esm/typings/src/utils/normalization/searchKeywords.test.d.ts +1 -1
  371. package/esm/typings/src/utils/organization/TODO_USE.d.ts +12 -12
  372. package/esm/typings/src/utils/organization/TODO_any.d.ts +6 -6
  373. package/esm/typings/src/utils/organization/TODO_object.d.ts +6 -6
  374. package/esm/typings/src/utils/organization/TODO_unknown.d.ts +6 -6
  375. package/esm/typings/src/utils/organization/___.d.ts +6 -6
  376. package/esm/typings/src/utils/organization/just.d.ts +14 -14
  377. package/esm/typings/src/utils/organization/keepUnused.d.ts +16 -16
  378. package/esm/typings/src/utils/organization/really_any.d.ts +6 -6
  379. package/esm/typings/src/utils/organization/really_unknown.d.ts +6 -6
  380. package/esm/typings/src/utils/parseNumber.d.ts +16 -15
  381. package/esm/typings/src/utils/parseNumber.test.d.ts +1 -1
  382. package/esm/typings/src/utils/random/randomSeed.d.ts +8 -7
  383. package/esm/typings/src/utils/removeEmojis.d.ts +8 -7
  384. package/esm/typings/src/utils/removeEmojis.test.d.ts +1 -1
  385. package/esm/typings/src/utils/removeQuotes.d.ts +14 -13
  386. package/esm/typings/src/utils/removeQuotes.test.d.ts +1 -1
  387. package/esm/typings/src/utils/replaceParameters.d.ts +12 -11
  388. package/esm/typings/src/utils/replaceParameters.test.d.ts +1 -1
  389. package/esm/typings/src/utils/sets/difference.d.ts +10 -9
  390. package/esm/typings/src/utils/sets/difference.test.d.ts +1 -1
  391. package/esm/typings/src/utils/sets/intersection.d.ts +7 -6
  392. package/esm/typings/src/utils/sets/intersection.test.d.ts +1 -1
  393. package/esm/typings/src/utils/sets/union.d.ts +7 -6
  394. package/esm/typings/src/utils/sets/union.test.d.ts +1 -1
  395. package/esm/typings/src/utils/trimCodeBlock.d.ts +9 -8
  396. package/esm/typings/src/utils/trimCodeBlock.test.d.ts +1 -1
  397. package/esm/typings/src/utils/trimEndOfCodeBlock.d.ts +9 -7
  398. package/esm/typings/src/utils/trimEndOfCodeBlock.test.d.ts +1 -1
  399. package/esm/typings/src/utils/unwrapResult.d.ts +37 -36
  400. package/esm/typings/src/utils/unwrapResult.test.d.ts +1 -1
  401. package/esm/typings/src/utils/validators/email/isValidEmail.d.ts +6 -6
  402. package/esm/typings/src/utils/validators/email/isValidEmail.test.d.ts +1 -1
  403. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +9 -8
  404. package/esm/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts +1 -1
  405. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +10 -3
  406. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts +1 -1
  407. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +15 -13
  408. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts +1 -1
  409. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts +12 -10
  410. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts +1 -1
  411. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts +11 -9
  412. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts +1 -1
  413. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +13 -12
  414. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts +1 -1
  415. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.d.ts +15 -13
  416. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts +1 -1
  417. package/esm/typings/src/utils/validators/url/isValidUrl.d.ts +13 -11
  418. package/esm/typings/src/utils/validators/url/isValidUrl.test.d.ts +1 -1
  419. package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts +8 -6
  420. package/esm/typings/src/utils/validators/uuid/isValidUuid.test.d.ts +1 -1
  421. package/esm/typings/src/version.d.ts +8 -6
  422. package/package.json +2 -2
  423. package/umd/index.umd.js +7926 -7736
  424. package/umd/index.umd.js.map +1 -1
  425. package/umd/typings/promptbook-collection/index.d.ts +252 -252
  426. package/umd/typings/src/_packages/anthropic-claude.index.d.ts +6 -5
  427. package/umd/typings/src/_packages/azure-openai.index.d.ts +6 -4
  428. package/umd/typings/src/_packages/browser.index.d.ts +6 -0
  429. package/umd/typings/src/_packages/cli.index.d.ts +4 -10
  430. package/umd/typings/src/_packages/core.index.d.ts +124 -50
  431. package/umd/typings/src/_packages/execute-javascript.index.d.ts +8 -48
  432. package/umd/typings/src/_packages/fake-llm.index.d.ts +6 -7
  433. package/umd/typings/src/_packages/langtail.index.d.ts +6 -4
  434. package/umd/typings/src/_packages/markdown-utils.index.d.ts +36 -17
  435. package/umd/typings/src/_packages/node.index.d.ts +8 -5
  436. package/umd/typings/src/_packages/openai.index.d.ts +8 -5
  437. package/umd/typings/src/_packages/remote-client.index.d.ts +8 -5
  438. package/umd/typings/src/_packages/remote-server.index.d.ts +6 -4
  439. package/umd/typings/src/_packages/types.index.d.ts +462 -42
  440. package/umd/typings/src/_packages/utils.index.d.ts +130 -77
  441. package/umd/typings/src/cli/cli-commands/hello.d.ts +10 -10
  442. package/umd/typings/src/cli/cli-commands/make.d.ts +10 -10
  443. package/umd/typings/src/cli/cli-commands/prettify.d.ts +10 -10
  444. package/umd/typings/src/cli/main.d.ts +12 -0
  445. package/umd/typings/src/cli/promptbookCli.d.ts +10 -10
  446. package/umd/typings/src/collection/PipelineCollection.d.ts +25 -25
  447. package/umd/typings/src/collection/SimplePipelineCollection.d.ts +38 -38
  448. package/umd/typings/src/collection/collectionToJson.d.ts +13 -11
  449. package/umd/typings/src/collection/collectionToJson.test.d.ts +7 -7
  450. package/umd/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +48 -47
  451. package/umd/typings/src/collection/constructors/createCollectionFromDirectory.test.d.ts +1 -1
  452. package/umd/typings/src/collection/constructors/createCollectionFromJson.d.ts +13 -12
  453. package/umd/typings/src/collection/constructors/createCollectionFromJson.test.d.ts +1 -1
  454. package/umd/typings/src/collection/constructors/createCollectionFromPromise.d.ts +23 -22
  455. package/umd/typings/src/collection/constructors/createCollectionFromPromise.test.d.ts +1 -1
  456. package/umd/typings/src/collection/constructors/createCollectionFromUrl.d.ts +29 -29
  457. package/umd/typings/src/collection/constructors/createSubcollection.d.ts +13 -12
  458. package/umd/typings/src/commands/BLOCK/BlockCommand.d.ts +11 -11
  459. package/umd/typings/src/commands/BLOCK/BlockTypes.d.ts +15 -13
  460. package/umd/typings/src/commands/BLOCK/blockCommand.test.d.ts +1 -1
  461. package/umd/typings/src/commands/BLOCK/blockCommandParser.d.ts +9 -9
  462. package/umd/typings/src/commands/EXPECT/ExpectAmountCommand.d.ts +14 -14
  463. package/umd/typings/src/commands/EXPECT/ExpectCommand.d.ts +9 -9
  464. package/umd/typings/src/commands/EXPECT/ExpectFormatCommand.d.ts +7 -7
  465. package/umd/typings/src/commands/EXPECT/expectCommand.test.d.ts +1 -1
  466. package/umd/typings/src/commands/EXPECT/expectCommandParser.d.ts +9 -9
  467. package/umd/typings/src/commands/JOKER/JokerCommand.d.ts +11 -11
  468. package/umd/typings/src/commands/JOKER/jokerCommand.test.d.ts +1 -1
  469. package/umd/typings/src/commands/JOKER/jokerCommandParser.d.ts +9 -9
  470. package/umd/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +11 -11
  471. package/umd/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts +1 -1
  472. package/umd/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +9 -9
  473. package/umd/typings/src/commands/MODEL/ModelCommand.d.ts +13 -13
  474. package/umd/typings/src/commands/MODEL/modelCommand.test.d.ts +1 -1
  475. package/umd/typings/src/commands/MODEL/modelCommandParser.d.ts +9 -9
  476. package/umd/typings/src/commands/PARAMETER/ParameterCommand.d.ts +15 -15
  477. package/umd/typings/src/commands/PARAMETER/parameterCommand.test.d.ts +1 -1
  478. package/umd/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +9 -9
  479. package/umd/typings/src/commands/PERSONA/PersonaCommand.d.ts +13 -13
  480. package/umd/typings/src/commands/PERSONA/personaCommand.test.d.ts +1 -1
  481. package/umd/typings/src/commands/PERSONA/personaCommandParser.d.ts +9 -9
  482. package/umd/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts +11 -11
  483. package/umd/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts +1 -1
  484. package/umd/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +9 -9
  485. package/umd/typings/src/commands/PROMPTBOOK_VERSION/PromptbookVersionCommand.d.ts +11 -11
  486. package/umd/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommand.test.d.ts +1 -1
  487. package/umd/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +9 -9
  488. package/umd/typings/src/commands/URL/UrlCommand.d.ts +10 -10
  489. package/umd/typings/src/commands/URL/urlCommand.test.d.ts +1 -1
  490. package/umd/typings/src/commands/URL/urlCommandParser.d.ts +9 -9
  491. package/umd/typings/src/commands/X_ACTION/ActionCommand.d.ts +9 -9
  492. package/umd/typings/src/commands/X_ACTION/actionCommand.test.d.ts +1 -1
  493. package/umd/typings/src/commands/X_ACTION/actionCommandParser.d.ts +9 -9
  494. package/umd/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +9 -9
  495. package/umd/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts +1 -1
  496. package/umd/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +9 -9
  497. package/umd/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +10 -10
  498. package/umd/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts +1 -1
  499. package/umd/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +13 -13
  500. package/umd/typings/src/commands/_common/parseCommand.d.ts +12 -12
  501. package/umd/typings/src/commands/_common/parseCommand.test.d.ts +1 -1
  502. package/umd/typings/src/commands/_common/types/Command.d.ts +6 -6
  503. package/umd/typings/src/commands/_common/types/CommandParser.d.ts +64 -64
  504. package/umd/typings/src/commands/_common/types/CommandUsagePlaces.d.ts +9 -9
  505. package/umd/typings/src/commands/index.d.ts +4 -4
  506. package/umd/typings/src/config.d.ts +87 -61
  507. package/umd/typings/src/config.test.d.ts +4 -4
  508. package/umd/typings/src/conversion/pipelineJsonToString.d.ts +16 -15
  509. package/umd/typings/src/conversion/pipelineStringToJson.d.ts +38 -35
  510. package/umd/typings/src/conversion/pipelineStringToJson.test.d.ts +1 -1
  511. package/umd/typings/src/conversion/pipelineStringToJsonSync.d.ts +29 -28
  512. package/umd/typings/src/conversion/pipelineStringToJsonSync.test.d.ts +1 -1
  513. package/umd/typings/src/conversion/prettify/PrettifyOptions.d.ts +13 -13
  514. package/umd/typings/src/conversion/prettify/prettifyPipelineString.d.ts +12 -10
  515. package/umd/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +27 -25
  516. package/umd/typings/src/conversion/utils/extractParameterNamesFromPromptTemplate.d.ts +14 -13
  517. package/umd/typings/src/conversion/utils/extractParameterNamesFromPromptTemplate.test.d.ts +1 -1
  518. package/umd/typings/src/conversion/utils/extractVariables.d.ts +14 -13
  519. package/umd/typings/src/conversion/utils/extractVariables.test.d.ts +1 -1
  520. package/umd/typings/src/conversion/utils/renameParameter.d.ts +26 -25
  521. package/umd/typings/src/conversion/utils/renameParameter.test.d.ts +1 -1
  522. package/umd/typings/src/conversion/utils/stringifyPipelineJson.d.ts +16 -14
  523. package/umd/typings/src/conversion/utils/stringifyPipelineJson.test.d.ts +1 -1
  524. package/umd/typings/src/conversion/utils/titleToName.d.ts +9 -4
  525. package/umd/typings/src/conversion/utils/titleToName.test.d.ts +1 -1
  526. package/umd/typings/src/conversion/validation/_importPipeline.d.ts +22 -22
  527. package/umd/typings/src/conversion/validation/pipelineStringToJson-syntaxErrors.test.d.ts +1 -1
  528. package/umd/typings/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +4 -4
  529. package/umd/typings/src/conversion/validation/validatePipeline.d.ts +37 -36
  530. package/umd/typings/src/conversion/validation/validatePipeline.test.d.ts +1 -1
  531. package/umd/typings/src/errors/CollectionError.d.ts +9 -7
  532. package/umd/typings/src/errors/EnvironmentMismatchError.d.ts +9 -7
  533. package/umd/typings/src/errors/LimitReachedError.d.ts +9 -7
  534. package/umd/typings/src/errors/NotFoundError.d.ts +9 -7
  535. package/umd/typings/src/errors/NotYetImplementedError.d.ts +9 -7
  536. package/umd/typings/src/errors/ParsingError.d.ts +9 -7
  537. package/umd/typings/src/errors/PipelineExecutionError.d.ts +9 -7
  538. package/umd/typings/src/errors/PipelineLogicError.d.ts +9 -7
  539. package/umd/typings/src/errors/ReferenceError.d.ts +9 -7
  540. package/umd/typings/src/errors/UnexpectedError.d.ts +9 -7
  541. package/umd/typings/src/errors/VersionMismatchError.d.ts +10 -8
  542. package/umd/typings/src/errors/_ExpectError.d.ts +10 -10
  543. package/umd/typings/src/execution/CommonExecutionToolsOptions.d.ts +10 -10
  544. package/umd/typings/src/execution/EmbeddingVector.d.ts +8 -8
  545. package/umd/typings/src/execution/ExecutionTools.d.ts +33 -33
  546. package/umd/typings/src/execution/LlmExecutionTools.d.ts +72 -72
  547. package/umd/typings/src/execution/PipelineExecutor.d.ts +64 -64
  548. package/umd/typings/src/execution/PromptResult.d.ts +99 -99
  549. package/umd/typings/src/execution/PromptResultUsage.d.ts +29 -29
  550. package/umd/typings/src/execution/ScriptExecutionTools.d.ts +39 -39
  551. package/umd/typings/src/execution/UncertainNumber.d.ts +18 -18
  552. package/umd/typings/src/execution/UserInterfaceTools.d.ts +46 -46
  553. package/umd/typings/src/execution/assertsExecutionSuccessful.d.ts +12 -11
  554. package/umd/typings/src/execution/createPipelineExecutor.d.ts +71 -70
  555. package/umd/typings/src/execution/embeddingVectorToString.d.ts +7 -5
  556. package/umd/typings/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +4 -4
  557. package/umd/typings/src/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +9 -9
  558. package/umd/typings/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +5 -5
  559. package/umd/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +11 -11
  560. package/umd/typings/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +4 -4
  561. package/umd/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +7 -7
  562. package/umd/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts +1 -1
  563. package/umd/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +5 -5
  564. package/umd/typings/src/execution/utils/addUsage.d.ts +65 -63
  565. package/umd/typings/src/execution/utils/addUsage.test.d.ts +1 -1
  566. package/umd/typings/src/execution/utils/checkExpectations.d.ts +27 -25
  567. package/umd/typings/src/execution/utils/checkExpectations.test.d.ts +1 -1
  568. package/umd/typings/src/execution/utils/computeUsageCounts.d.ts +10 -10
  569. package/umd/typings/src/execution/utils/forEachAsync.d.ts +19 -18
  570. package/umd/typings/src/execution/utils/uncertainNumber.d.ts +9 -9
  571. package/umd/typings/src/execution/utils/usageToHuman.d.ts +17 -15
  572. package/umd/typings/src/execution/utils/usageToHuman.test.d.ts +1 -1
  573. package/umd/typings/src/execution/utils/usageToWorktime.d.ts +12 -10
  574. package/umd/typings/src/execution/utils/usageToWorktime.test.d.ts +1 -1
  575. package/umd/typings/src/expectations/drafts/isDomainNameFree.d.ts +6 -6
  576. package/umd/typings/src/expectations/drafts/isGithubNameFree.d.ts +6 -6
  577. package/umd/typings/src/formats/_common/FormatDefinition.d.ts +70 -69
  578. package/umd/typings/src/formats/csv/ListFormatDefinition.d.ts +12 -12
  579. package/umd/typings/src/formats/index.d.ts +4 -4
  580. package/umd/typings/src/formats/json/JsonFormatDefinition.d.ts +16 -16
  581. package/umd/typings/src/formats/json/utils/isValidJsonString.d.ts +6 -4
  582. package/umd/typings/src/formats/json/utils/isValidJsonString.test.d.ts +1 -1
  583. package/umd/typings/src/formats/list/ListFormatDefinition.d.ts +14 -14
  584. package/umd/typings/src/formats/xml/XmlFormatDefinition.d.ts +16 -16
  585. package/umd/typings/src/knowledge/dialogs/callback/CallbackInterfaceTools.d.ts +17 -15
  586. package/umd/typings/src/knowledge/dialogs/callback/CallbackInterfaceToolsOptions.d.ts +14 -12
  587. package/umd/typings/src/knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +22 -20
  588. package/umd/typings/src/knowledge/dialogs/user-interface-execution-tools.test.d.ts +1 -1
  589. package/umd/typings/src/knowledge/prepare-knowledge/_common/Scraper.d.ts +37 -27
  590. package/umd/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.d.ts +18 -18
  591. package/umd/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.test.d.ts +1 -1
  592. package/umd/typings/src/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts +2 -2
  593. package/umd/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +14 -12
  594. package/umd/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts +4 -4
  595. package/umd/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +13 -13
  596. package/umd/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts +1 -1
  597. package/umd/typings/src/llm-providers/_common/createLlmToolsFromEnv.d.ts +37 -34
  598. package/umd/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts +20 -20
  599. package/umd/typings/src/llm-providers/_common/getLlmToolsForTestingAndScriptsAndPlayground.d.ts +21 -21
  600. package/umd/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts +29 -29
  601. package/umd/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +16 -16
  602. package/umd/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts +19 -19
  603. package/umd/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +15 -15
  604. package/umd/typings/src/llm-providers/_common/utils/count-total-usage/countTotalUsage.d.ts +17 -17
  605. package/umd/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +36 -35
  606. package/umd/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +52 -50
  607. package/umd/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +12 -11
  608. package/umd/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +22 -22
  609. package/umd/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +6 -6
  610. package/umd/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +50 -48
  611. package/umd/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +36 -35
  612. package/umd/typings/src/llm-providers/azure-openai/playground/playground.d.ts +5 -5
  613. package/umd/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +17 -15
  614. package/umd/typings/src/llm-providers/langtail/LangtailExecutionToolsOptions.d.ts +13 -11
  615. package/umd/typings/src/llm-providers/langtail/playground/playground.d.ts +2 -2
  616. package/umd/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +36 -34
  617. package/umd/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +40 -38
  618. package/umd/typings/src/llm-providers/mocked/fakeTextToExpectations.d.ts +14 -14
  619. package/umd/typings/src/llm-providers/mocked/test/fakeTextToExpectations.test.d.ts +1 -1
  620. package/umd/typings/src/llm-providers/mocked/test/faked-completion.test.d.ts +1 -1
  621. package/umd/typings/src/llm-providers/mocked/test/joker.test.d.ts +4 -4
  622. package/umd/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts +5 -5
  623. package/umd/typings/src/llm-providers/mocked/test/mocked-completion.test.d.ts +4 -4
  624. package/umd/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +54 -54
  625. package/umd/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +21 -19
  626. package/umd/typings/src/llm-providers/multiple/playground/playground.d.ts +2 -2
  627. package/umd/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +68 -66
  628. package/umd/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +20 -18
  629. package/umd/typings/src/llm-providers/openai/computeOpenaiUsage.d.ts +14 -14
  630. package/umd/typings/src/llm-providers/openai/computeOpenaiUsage.test.d.ts +1 -1
  631. package/umd/typings/src/llm-providers/openai/computeUsage.d.ts +16 -16
  632. package/umd/typings/src/llm-providers/openai/computeUsage.test.d.ts +1 -1
  633. package/umd/typings/src/llm-providers/openai/openai-models.d.ts +29 -28
  634. package/umd/typings/src/llm-providers/openai/playground/playground.d.ts +5 -5
  635. package/umd/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +56 -55
  636. package/umd/typings/src/llm-providers/remote/RemoteLlmExecutionToolsOptions.d.ts +26 -24
  637. package/umd/typings/src/llm-providers/remote/interfaces/Promptbook_Server_Error.d.ts +11 -11
  638. package/umd/typings/src/llm-providers/remote/interfaces/Promptbook_Server_Progress.d.ts +12 -12
  639. package/umd/typings/src/llm-providers/remote/interfaces/Promptbook_Server_Request.d.ts +17 -17
  640. package/umd/typings/src/llm-providers/remote/interfaces/Promptbook_Server_Response.d.ts +12 -12
  641. package/umd/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts +37 -31
  642. package/umd/typings/src/llm-providers/remote/startRemoteServer.d.ts +21 -20
  643. package/umd/typings/src/personas/preparePersona.d.ts +15 -15
  644. package/umd/typings/src/personas/preparePersona.test.d.ts +1 -1
  645. package/umd/typings/src/postprocessing/utils/extractBlock.d.ts +17 -12
  646. package/umd/typings/src/prepare/PrepareOptions.d.ts +22 -22
  647. package/umd/typings/src/prepare/isPipelinePrepared.d.ts +15 -14
  648. package/umd/typings/src/prepare/isPipelinePrepared.test.d.ts +1 -1
  649. package/umd/typings/src/prepare/preparePipeline.d.ts +16 -16
  650. package/umd/typings/src/prepare/prepareTemplates.d.ts +32 -31
  651. package/umd/typings/src/prepare/unpreparePipeline.d.ts +12 -11
  652. package/umd/typings/src/scripting/_test/custom-function-async.test.ts.test.d.ts +1 -1
  653. package/umd/typings/src/scripting/_test/custom-function-missing.test.d.ts +1 -1
  654. package/umd/typings/src/scripting/_test/custom-function-with-dependencies.test.d.ts +1 -1
  655. package/umd/typings/src/scripting/_test/custom-function.test.d.ts +1 -1
  656. package/umd/typings/src/scripting/_test/postprocessing.test.d.ts +1 -1
  657. package/umd/typings/src/scripting/_test/script-execution-errors.test.d.ts +1 -1
  658. package/umd/typings/src/scripting/_test/script-execution-tools.test.d.ts +1 -1
  659. package/umd/typings/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +22 -20
  660. package/umd/typings/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -4
  661. package/umd/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts +8 -7
  662. package/umd/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +26 -26
  663. package/umd/typings/src/scripting/javascript/postprocessing-functions.d.ts +51 -0
  664. package/umd/typings/src/scripting/javascript/utils/preserve.d.ts +12 -12
  665. package/umd/typings/src/scripting/javascript/utils/unknownToString.d.ts +8 -8
  666. package/umd/typings/src/scripting/python/PythonExecutionTools.d.ts +16 -16
  667. package/umd/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +16 -16
  668. package/umd/typings/src/storage/_common/PromptbookStorage.d.ts +24 -25
  669. package/umd/typings/src/storage/_common/PromptbookStorage.test-type.d.ts +5 -5
  670. package/umd/typings/src/storage/files-storage/FilesStorage.d.ts +31 -30
  671. package/umd/typings/src/storage/files-storage/FilesStorageOptions.d.ts +10 -13
  672. package/umd/typings/src/storage/files-storage/utils/nameToSubfolderPath.d.ts +7 -7
  673. package/umd/typings/src/storage/files-storage/utils/nameToSubfolderPath.test.d.ts +1 -1
  674. package/umd/typings/src/storage/local-storage/getLocalStorage.d.ts +10 -9
  675. package/umd/typings/src/storage/local-storage/getSessionStorage.d.ts +10 -9
  676. package/umd/typings/src/storage/memory/MemoryStorage.d.ts +33 -34
  677. package/umd/typings/src/storage/utils/PrefixStorage.d.ts +25 -26
  678. package/umd/typings/src/storage/utils/makePromptbookStorageFromWebStorage.d.ts +11 -11
  679. package/umd/typings/src/types/Arrayable.d.ts +10 -10
  680. package/umd/typings/src/types/ModelRequirements.d.ts +102 -103
  681. package/umd/typings/src/types/ModelVariant.d.ts +14 -14
  682. package/umd/typings/src/types/PipelineJson/Expectations.d.ts +32 -32
  683. package/umd/typings/src/types/PipelineJson/KnowledgePieceJson.d.ts +70 -70
  684. package/umd/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts +27 -27
  685. package/umd/typings/src/types/PipelineJson/LlmTemplateJson.d.ts +25 -25
  686. package/umd/typings/src/types/PipelineJson/PersonaJson.d.ts +41 -41
  687. package/umd/typings/src/types/PipelineJson/PipelineJson.d.ts +87 -87
  688. package/umd/typings/src/types/PipelineJson/PreparationJson.d.ts +22 -22
  689. package/umd/typings/src/types/PipelineJson/PromptDialogJson.d.ts +13 -13
  690. package/umd/typings/src/types/PipelineJson/PromptTemplateJson.d.ts +13 -13
  691. package/umd/typings/src/types/PipelineJson/PromptTemplateJsonCommon.d.ts +96 -96
  692. package/umd/typings/src/types/PipelineJson/PromptTemplateParameterJson.d.ts +36 -36
  693. package/umd/typings/src/types/PipelineJson/ScriptJson.d.ts +19 -19
  694. package/umd/typings/src/types/PipelineJson/SimpleTemplateJson.d.ts +12 -12
  695. package/umd/typings/src/types/PipelineString.d.ts +12 -12
  696. package/umd/typings/src/types/Prompt.d.ts +108 -109
  697. package/umd/typings/src/types/ScriptLanguage.d.ts +9 -9
  698. package/umd/typings/src/types/TaskProgress.d.ts +43 -43
  699. package/umd/typings/src/types/execution-report/ExecutionReportJson.d.ts +58 -58
  700. package/umd/typings/src/types/execution-report/ExecutionReportString.d.ts +16 -16
  701. package/umd/typings/src/types/execution-report/ExecutionReportStringOptions.d.ts +25 -21
  702. package/umd/typings/src/types/execution-report/config.d.ts +8 -8
  703. package/umd/typings/src/types/execution-report/countWorkingDuration.d.ts +7 -7
  704. package/umd/typings/src/types/execution-report/countWorkingDuration.test.d.ts +1 -1
  705. package/umd/typings/src/types/execution-report/executionReportJsonToString.d.ts +13 -11
  706. package/umd/typings/src/types/typeAliasEmoji.d.ts +9 -9
  707. package/umd/typings/src/types/typeAliases.d.ts +586 -579
  708. package/umd/typings/src/utils/FromtoItems.d.ts +19 -19
  709. package/umd/typings/src/utils/arrayableToArray.d.ts +11 -11
  710. package/umd/typings/src/utils/arrayableToArray.test.d.ts +1 -1
  711. package/umd/typings/src/utils/currentDate.d.ts +8 -7
  712. package/umd/typings/src/utils/deepClone.d.ts +10 -9
  713. package/umd/typings/src/utils/deepFreeze.d.ts +22 -22
  714. package/umd/typings/src/utils/emojis.d.ts +23 -23
  715. package/umd/typings/src/utils/expectation-counters/countCharacters.d.ts +7 -5
  716. package/umd/typings/src/utils/expectation-counters/countCharacters.test.d.ts +1 -1
  717. package/umd/typings/src/utils/expectation-counters/countLines.d.ts +7 -5
  718. package/umd/typings/src/utils/expectation-counters/countLines.test.d.ts +1 -1
  719. package/umd/typings/src/utils/expectation-counters/countPages.d.ts +7 -5
  720. package/umd/typings/src/utils/expectation-counters/countPages.test.d.ts +1 -1
  721. package/umd/typings/src/utils/expectation-counters/countParagraphs.d.ts +7 -5
  722. package/umd/typings/src/utils/expectation-counters/countParagraphs.test.d.ts +1 -1
  723. package/umd/typings/src/utils/expectation-counters/countSentences.d.ts +13 -9
  724. package/umd/typings/src/utils/expectation-counters/countSentences.test.d.ts +1 -1
  725. package/umd/typings/src/utils/expectation-counters/countWords.d.ts +7 -5
  726. package/umd/typings/src/utils/expectation-counters/countWords.test.d.ts +1 -1
  727. package/umd/typings/src/utils/expectation-counters/index.d.ts +8 -6
  728. package/umd/typings/src/utils/extractParameterNames.d.ts +10 -9
  729. package/umd/typings/src/utils/extractParameterNames.test.d.ts +1 -1
  730. package/umd/typings/src/utils/formatNumber.d.ts +6 -6
  731. package/umd/typings/src/utils/formatNumber.test.d.ts +1 -1
  732. package/umd/typings/src/utils/getCurrentIsoDate.d.ts +7 -7
  733. package/umd/typings/src/utils/isRunningInWhatever.d.ts +18 -15
  734. package/umd/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +14 -11
  735. package/umd/typings/src/utils/markdown/addAutoGeneratedSection.test.d.ts +1 -1
  736. package/umd/typings/src/utils/markdown/createMarkdownChart.d.ts +38 -38
  737. package/umd/typings/src/utils/markdown/createMarkdownChart.test.d.ts +1 -1
  738. package/umd/typings/src/utils/markdown/createMarkdownTable.d.ts +11 -8
  739. package/umd/typings/src/utils/markdown/createMarkdownTable.test.d.ts +1 -1
  740. package/umd/typings/src/utils/markdown/escapeMarkdownBlock.d.ts +11 -6
  741. package/umd/typings/src/utils/markdown/escapeMarkdownBlock.test.d.ts +1 -1
  742. package/umd/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts +1 -1
  743. package/umd/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +34 -34
  744. package/umd/typings/src/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts +1 -1
  745. package/umd/typings/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +15 -14
  746. package/umd/typings/src/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts +1 -1
  747. package/umd/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +20 -19
  748. package/umd/typings/src/utils/markdown/extractOneBlockFromMarkdown.test.d.ts +1 -1
  749. package/umd/typings/src/utils/markdown/flattenMarkdown.d.ts +17 -14
  750. package/umd/typings/src/utils/markdown/flattenMarkdown.test.d.ts +1 -1
  751. package/umd/typings/src/utils/markdown/parseMarkdownSection.d.ts +34 -30
  752. package/umd/typings/src/utils/markdown/parseMarkdownSection.test.d.ts +1 -1
  753. package/umd/typings/src/utils/markdown/prettifyMarkdown.d.ts +9 -9
  754. package/umd/typings/src/utils/markdown/prettifyMarkdown.test.d.ts +1 -1
  755. package/umd/typings/src/utils/markdown/removeContentComments.d.ts +10 -9
  756. package/umd/typings/src/utils/markdown/removeContentComments.test.d.ts +1 -1
  757. package/umd/typings/src/utils/markdown/removeMarkdownFormatting.d.ts +9 -8
  758. package/umd/typings/src/utils/markdown/removeMarkdownFormatting.test.d.ts +1 -1
  759. package/umd/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +15 -12
  760. package/umd/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts +1 -1
  761. package/umd/typings/src/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts +12 -10
  762. package/umd/typings/src/utils/normalization/IKeywords.d.ts +21 -18
  763. package/umd/typings/src/utils/normalization/capitalize.d.ts +6 -5
  764. package/umd/typings/src/utils/normalization/capitalize.test.d.ts +1 -1
  765. package/umd/typings/src/utils/normalization/decapitalize.d.ts +6 -5
  766. package/umd/typings/src/utils/normalization/decapitalize.test.d.ts +1 -1
  767. package/umd/typings/src/utils/normalization/isValidKeyword.d.ts +10 -8
  768. package/umd/typings/src/utils/normalization/isValidKeyword.test.d.ts +1 -1
  769. package/umd/typings/src/utils/normalization/nameToUriPart.d.ts +9 -1
  770. package/umd/typings/src/utils/normalization/nameToUriPart.test.d.ts +1 -1
  771. package/umd/typings/src/utils/normalization/nameToUriParts.d.ts +9 -1
  772. package/umd/typings/src/utils/normalization/nameToUriParts.test.d.ts +1 -1
  773. package/umd/typings/src/utils/normalization/normalize-to-kebab-case.d.ts +18 -8
  774. package/umd/typings/src/utils/normalization/normalize-to-kebab-case.test.d.ts +1 -1
  775. package/umd/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts +17 -8
  776. package/umd/typings/src/utils/normalization/normalizeTo_PascalCase.test.d.ts +1 -1
  777. package/umd/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +26 -16
  778. package/umd/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts +1 -1
  779. package/umd/typings/src/utils/normalization/normalizeTo_camelCase.d.ts +22 -11
  780. package/umd/typings/src/utils/normalization/normalizeTo_camelCase.test.d.ts +1 -1
  781. package/umd/typings/src/utils/normalization/normalizeTo_snake_case.d.ts +17 -8
  782. package/umd/typings/src/utils/normalization/normalizeTo_snake_case.test.d.ts +1 -1
  783. package/umd/typings/src/utils/normalization/normalizeWhitespaces.d.ts +4 -4
  784. package/umd/typings/src/utils/normalization/normalizeWhitespaces.test.d.ts +1 -1
  785. package/umd/typings/src/utils/normalization/parseKeywords.d.ts +16 -15
  786. package/umd/typings/src/utils/normalization/parseKeywords.test.d.ts +1 -1
  787. package/umd/typings/src/utils/normalization/parseKeywordsFromString.d.ts +9 -8
  788. package/umd/typings/src/utils/normalization/parseKeywordsFromString.test.d.ts +1 -1
  789. package/umd/typings/src/utils/normalization/removeDiacritics.d.ts +11 -4
  790. package/umd/typings/src/utils/normalization/removeDiacritics.test.d.ts +1 -1
  791. package/umd/typings/src/utils/normalization/searchKeywords.d.ts +10 -5
  792. package/umd/typings/src/utils/normalization/searchKeywords.test.d.ts +1 -1
  793. package/umd/typings/src/utils/organization/TODO_USE.d.ts +12 -12
  794. package/umd/typings/src/utils/organization/TODO_any.d.ts +6 -6
  795. package/umd/typings/src/utils/organization/TODO_object.d.ts +6 -6
  796. package/umd/typings/src/utils/organization/TODO_unknown.d.ts +6 -6
  797. package/umd/typings/src/utils/organization/___.d.ts +6 -6
  798. package/umd/typings/src/utils/organization/just.d.ts +14 -14
  799. package/umd/typings/src/utils/organization/keepUnused.d.ts +16 -16
  800. package/umd/typings/src/utils/organization/really_any.d.ts +6 -6
  801. package/umd/typings/src/utils/organization/really_unknown.d.ts +6 -6
  802. package/umd/typings/src/utils/parseNumber.d.ts +16 -15
  803. package/umd/typings/src/utils/parseNumber.test.d.ts +1 -1
  804. package/umd/typings/src/utils/random/randomSeed.d.ts +8 -7
  805. package/umd/typings/src/utils/removeEmojis.d.ts +8 -7
  806. package/umd/typings/src/utils/removeEmojis.test.d.ts +1 -1
  807. package/umd/typings/src/utils/removeQuotes.d.ts +14 -13
  808. package/umd/typings/src/utils/removeQuotes.test.d.ts +1 -1
  809. package/umd/typings/src/utils/replaceParameters.d.ts +12 -11
  810. package/umd/typings/src/utils/replaceParameters.test.d.ts +1 -1
  811. package/umd/typings/src/utils/sets/difference.d.ts +10 -9
  812. package/umd/typings/src/utils/sets/difference.test.d.ts +1 -1
  813. package/umd/typings/src/utils/sets/intersection.d.ts +7 -6
  814. package/umd/typings/src/utils/sets/intersection.test.d.ts +1 -1
  815. package/umd/typings/src/utils/sets/union.d.ts +7 -6
  816. package/umd/typings/src/utils/sets/union.test.d.ts +1 -1
  817. package/umd/typings/src/utils/trimCodeBlock.d.ts +9 -8
  818. package/umd/typings/src/utils/trimCodeBlock.test.d.ts +1 -1
  819. package/umd/typings/src/utils/trimEndOfCodeBlock.d.ts +9 -7
  820. package/umd/typings/src/utils/trimEndOfCodeBlock.test.d.ts +1 -1
  821. package/umd/typings/src/utils/unwrapResult.d.ts +37 -36
  822. package/umd/typings/src/utils/unwrapResult.test.d.ts +1 -1
  823. package/umd/typings/src/utils/validators/email/isValidEmail.d.ts +6 -6
  824. package/umd/typings/src/utils/validators/email/isValidEmail.test.d.ts +1 -1
  825. package/umd/typings/src/utils/validators/filePath/isValidFilePath.d.ts +9 -8
  826. package/umd/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts +1 -1
  827. package/umd/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +10 -3
  828. package/umd/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts +1 -1
  829. package/umd/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +15 -13
  830. package/umd/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts +1 -1
  831. package/umd/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts +12 -10
  832. package/umd/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts +1 -1
  833. package/umd/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts +11 -9
  834. package/umd/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts +1 -1
  835. package/umd/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +13 -12
  836. package/umd/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts +1 -1
  837. package/umd/typings/src/utils/validators/url/isValidPipelineUrl.d.ts +15 -13
  838. package/umd/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts +1 -1
  839. package/umd/typings/src/utils/validators/url/isValidUrl.d.ts +13 -11
  840. package/umd/typings/src/utils/validators/url/isValidUrl.test.d.ts +1 -1
  841. package/umd/typings/src/utils/validators/uuid/isValidUuid.d.ts +8 -6
  842. package/umd/typings/src/utils/validators/uuid/isValidUuid.test.d.ts +1 -1
  843. package/umd/typings/src/version.d.ts +8 -6
@@ -1,18 +1,20 @@
1
- import type { ClientOptions } from 'openai';
2
- import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
3
- import type { string_token } from '../../types/typeAliases';
4
- /**
5
- * Options for `OpenAiExecutionTools`
6
- *
7
- * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
8
- * Rest is used by the `OpenAiExecutionTools`.
9
- */
10
- export type OpenAiExecutionToolsOptions = CommonExecutionToolsOptions & ClientOptions & {
11
- /**
12
- * A unique identifier representing your end-user, which can help OpenAI to monitor
13
- * and detect abuse.
14
- *
15
- * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids
16
- */
17
- user?: string_token;
18
- };
1
+ import type { ClientOptions } from 'openai';
2
+ import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
3
+ import type { string_token } from '../../types/typeAliases';
4
+ /**
5
+ * Options for `OpenAiExecutionTools`
6
+ *
7
+ * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
8
+ * Rest is used by the `OpenAiExecutionTools`.
9
+ *
10
+ * @public exported from `@promptbook/openai`
11
+ */
12
+ export type OpenAiExecutionToolsOptions = CommonExecutionToolsOptions & ClientOptions & {
13
+ /**
14
+ * A unique identifier representing your end-user, which can help OpenAI to monitor
15
+ * and detect abuse.
16
+ *
17
+ * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids
18
+ */
19
+ user?: string_token;
20
+ };
@@ -1,14 +1,14 @@
1
- import type OpenAI from 'openai';
2
- import type { PromptResultUsage } from '../../execution/PromptResultUsage';
3
- import type { Prompt } from '../../types/Prompt';
4
- /**
5
- * Computes the usage of the OpenAI API based on the response from OpenAI
6
- *
7
- * @param promptContent The content of the prompt
8
- * @param resultContent The content of the result (for embedding prompts or failed prompts pass empty string)
9
- * @param rawResponse The raw response from OpenAI API
10
- * @throws {PipelineExecutionError} If the usage is not defined in the response from OpenAI
11
- * @private internal util of `OpenAiExecutionTools`
12
- */
13
- export declare function computeOpenaiUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
14
- resultContent: string, rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>): PromptResultUsage;
1
+ import type OpenAI from 'openai';
2
+ import type { PromptResultUsage } from '../../execution/PromptResultUsage';
3
+ import type { Prompt } from '../../types/Prompt';
4
+ /**
5
+ * Computes the usage of the OpenAI API based on the response from OpenAI
6
+ *
7
+ * @param promptContent The content of the prompt
8
+ * @param resultContent The content of the result (for embedding prompts or failed prompts pass empty string)
9
+ * @param rawResponse The raw response from OpenAI API
10
+ * @throws {PipelineExecutionError} If the usage is not defined in the response from OpenAI
11
+ * @private internal util of `OpenAiExecutionTools`
12
+ */
13
+ export declare function computeOpenaiUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
14
+ resultContent: string, rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>): PromptResultUsage;
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,16 +1,16 @@
1
- /**
2
- * String value found on OpenAI and Anthropic Claude page
3
- *
4
- * @see https://openai.com/api/pricing/
5
- * @see https://docs.anthropic.com/en/docs/models-overview
6
- *
7
- * @private within the repository, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
8
- */
9
- type string_model_price = `$${number}.${number} / ${number}M tokens`;
10
- /**
11
- * Function computeUsage will create price per one token based on the string value found on openai page
12
- *
13
- * @private within the repository, used only as internal helper for `OPENAI_MODELS`
14
- */
15
- export declare function computeUsage(value: string_model_price): number;
16
- export {};
1
+ /**
2
+ * String value found on OpenAI and Anthropic Claude page
3
+ *
4
+ * @see https://openai.com/api/pricing/
5
+ * @see https://docs.anthropic.com/en/docs/models-overview
6
+ *
7
+ * @private within the repository, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
8
+ */
9
+ type string_model_price = `$${number}.${number} / ${number}M tokens`;
10
+ /**
11
+ * Function computeUsage will create price per one token based on the string value found on openai page
12
+ *
13
+ * @private within the repository, used only as internal helper for `OPENAI_MODELS`
14
+ */
15
+ export declare function computeUsage(value: string_model_price): number;
16
+ export {};
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,28 +1,29 @@
1
- import type { AvailableModel } from '../../execution/LlmExecutionTools';
2
- import type { number_usd } from '../../types/typeAliases';
3
- /**
4
- * List of available OpenAI models with pricing
5
- *
6
- * Note: Done at 2024-05-20
7
- *
8
- * @see https://platform.openai.com/docs/models/
9
- * @see https://openai.com/api/pricing/
10
- */
11
- export declare const OPENAI_MODELS: Array<AvailableModel & {
12
- pricing?: {
13
- readonly prompt: number_usd;
14
- readonly output: number_usd;
15
- };
16
- }>;
17
- /**
18
- * Note: [🤖] Add models of new variant
19
- * TODO: [🧠] Some mechanism to propagate unsureness
20
- * TODO: [🕚][👮‍♀️] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
21
- * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths ( Top-level performance, intelligence, fluency, and understanding), contextWindow,...
22
- * @see https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4
23
- * @see https://openai.com/api/pricing/
24
- * @see /other/playground/playground.ts
25
- * TODO: [🍓] Make better
26
- * TODO: Change model titles to human eg: "gpt-4-turbo-2024-04-09" -> "GPT-4 Turbo (2024-04-09)"
27
- * TODO: [🚸] Not all models are compatible with JSON mode, add this information here and use it
28
- */
1
+ import type { AvailableModel } from '../../execution/LlmExecutionTools';
2
+ import type { number_usd } from '../../types/typeAliases';
3
+ /**
4
+ * List of available OpenAI models with pricing
5
+ *
6
+ * Note: Done at 2024-05-20
7
+ *
8
+ * @see https://platform.openai.com/docs/models/
9
+ * @see https://openai.com/api/pricing/
10
+ * @public exported from `@promptbook/openai`
11
+ */
12
+ export declare const OPENAI_MODELS: Array<AvailableModel & {
13
+ pricing?: {
14
+ readonly prompt: number_usd;
15
+ readonly output: number_usd;
16
+ };
17
+ }>;
18
+ /**
19
+ * Note: [🤖] Add models of new variant
20
+ * TODO: [🧠] Some mechanism to propagate unsureness
21
+ * TODO: [🕚][👮‍♀️] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
22
+ * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths ( Top-level performance, intelligence, fluency, and understanding), contextWindow,...
23
+ * @see https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4
24
+ * @see https://openai.com/api/pricing/
25
+ * @see /other/playground/playground.ts
26
+ * TODO: [🍓] Make better
27
+ * TODO: Change model titles to human eg: "gpt-4-turbo-2024-04-09" -> "GPT-4 Turbo (2024-04-09)"
28
+ * TODO: [🚸] Not all models are compatible with JSON mode, add this information here and use it
29
+ */
@@ -1,5 +1,5 @@
1
- #!/usr/bin/env ts-node
2
- export {};
3
- /**
4
- * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
5
- */
1
+ #!/usr/bin/env ts-node
2
+ export {};
3
+ /**
4
+ * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
5
+ */
@@ -1,55 +1,56 @@
1
- import type { AvailableModel } from '../../execution/LlmExecutionTools';
2
- import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
3
- import type { ChatPromptResult } from '../../execution/PromptResult';
4
- import type { CompletionPromptResult } from '../../execution/PromptResult';
5
- import type { EmbeddingPromptResult } from '../../execution/PromptResult';
6
- import type { ChatPrompt } from '../../types/Prompt';
7
- import type { CompletionPrompt } from '../../types/Prompt';
8
- import type { EmbeddingPrompt } from '../../types/Prompt';
9
- import type { string_markdown } from '../../types/typeAliases';
10
- import type { string_markdown_text } from '../../types/typeAliases';
11
- import type { string_title } from '../../types/typeAliases';
12
- import type { RemoteLlmExecutionToolsOptions } from './RemoteLlmExecutionToolsOptions';
13
- /**
14
- * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
15
- *
16
- * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
17
- * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
18
- *
19
- * @see https://github.com/webgptorg/promptbook#remote-server
20
- */
21
- export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
22
- private readonly options;
23
- constructor(options: RemoteLlmExecutionToolsOptions);
24
- get title(): string_title & string_markdown_text;
25
- get description(): string_markdown;
26
- /**
27
- * Creates a connection to the remote proxy server.
28
- */
29
- private makeConnection;
30
- /**
31
- * Calls remote proxy server to use a chat model
32
- */
33
- callChatModel(prompt: ChatPrompt): Promise<ChatPromptResult>;
34
- /**
35
- * Calls remote proxy server to use a completion model
36
- */
37
- callCompletionModel(prompt: CompletionPrompt): Promise<CompletionPromptResult>;
38
- /**
39
- * Calls remote proxy server to use a embedding model
40
- */
41
- callEmbeddingModel(prompt: EmbeddingPrompt): Promise<EmbeddingPromptResult>;
42
- /**
43
- * Calls remote proxy server to use both completion or chat model
44
- */
45
- private callModelCommon;
46
- /**
47
- * List all available models that can be used
48
- */
49
- listModels(): Promise<Array<AvailableModel>>;
50
- }
51
- /**
52
- * TODO: [🍓] Allow to list compatible models with each variant
53
- * TODO: [🗯] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
54
- * TODO: [🍜] Add anonymous option
55
- */
1
+ import type { AvailableModel } from '../../execution/LlmExecutionTools';
2
+ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
3
+ import type { ChatPromptResult } from '../../execution/PromptResult';
4
+ import type { CompletionPromptResult } from '../../execution/PromptResult';
5
+ import type { EmbeddingPromptResult } from '../../execution/PromptResult';
6
+ import type { ChatPrompt } from '../../types/Prompt';
7
+ import type { CompletionPrompt } from '../../types/Prompt';
8
+ import type { EmbeddingPrompt } from '../../types/Prompt';
9
+ import type { string_markdown } from '../../types/typeAliases';
10
+ import type { string_markdown_text } from '../../types/typeAliases';
11
+ import type { string_title } from '../../types/typeAliases';
12
+ import type { RemoteLlmExecutionToolsOptions } from './RemoteLlmExecutionToolsOptions';
13
+ /**
14
+ * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
15
+ *
16
+ * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
17
+ * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
18
+ *
19
+ * @see https://github.com/webgptorg/promptbook#remote-server
20
+ * @public exported from `@promptbook/remote-client`
21
+ */
22
+ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
23
+ private readonly options;
24
+ constructor(options: RemoteLlmExecutionToolsOptions);
25
+ get title(): string_title & string_markdown_text;
26
+ get description(): string_markdown;
27
+ /**
28
+ * Creates a connection to the remote proxy server.
29
+ */
30
+ private makeConnection;
31
+ /**
32
+ * Calls remote proxy server to use a chat model
33
+ */
34
+ callChatModel(prompt: ChatPrompt): Promise<ChatPromptResult>;
35
+ /**
36
+ * Calls remote proxy server to use a completion model
37
+ */
38
+ callCompletionModel(prompt: CompletionPrompt): Promise<CompletionPromptResult>;
39
+ /**
40
+ * Calls remote proxy server to use a embedding model
41
+ */
42
+ callEmbeddingModel(prompt: EmbeddingPrompt): Promise<EmbeddingPromptResult>;
43
+ /**
44
+ * Calls remote proxy server to use both completion or chat model
45
+ */
46
+ private callModelCommon;
47
+ /**
48
+ * List all available models that can be used
49
+ */
50
+ listModels(): Promise<Array<AvailableModel>>;
51
+ }
52
+ /**
53
+ * TODO: [🍓] Allow to list compatible models with each variant
54
+ * TODO: [🗯] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
55
+ * TODO: [🍜] Add anonymous option
56
+ */
@@ -1,24 +1,26 @@
1
- import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
2
- import type { client_id } from '../../types/typeAliases';
3
- import type { string_uri } from '../../types/typeAliases';
4
- /**
5
- * Options for `RemoteLlmExecutionTools`
6
- */
7
- export type RemoteLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
8
- /**
9
- * URL of the remote PROMPTBOOK server
10
- * On this server will be connected to the socket.io server
11
- */
12
- readonly remoteUrl: URL;
13
- /**
14
- * Path for the Socket.io server to listen
15
- *
16
- * @default '/socket.io'
17
- * @example '/promptbook/socket.io'
18
- */
19
- readonly path: string_uri;
20
- /**
21
- * Your client ID
22
- */
23
- readonly clientId: client_id;
24
- };
1
+ import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
2
+ import type { client_id } from '../../types/typeAliases';
3
+ import type { string_uri } from '../../types/typeAliases';
4
+ /**
5
+ * Options for `RemoteLlmExecutionTools`
6
+ *
7
+ * @public exported from `@promptbook/remote-client`
8
+ */
9
+ export type RemoteLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
10
+ /**
11
+ * URL of the remote PROMPTBOOK server
12
+ * On this server will be connected to the socket.io server
13
+ */
14
+ readonly remoteUrl: URL;
15
+ /**
16
+ * Path for the Socket.io server to listen
17
+ *
18
+ * @default '/socket.io'
19
+ * @example '/promptbook/socket.io'
20
+ */
21
+ readonly path: string_uri;
22
+ /**
23
+ * Your client ID
24
+ */
25
+ readonly clientId: client_id;
26
+ };
@@ -1,11 +1,11 @@
1
- /**
2
- * Socket.io error for remote text generation
3
- *
4
- * This is sent from server to client when error occurs and stops the process
5
- */
6
- export interface Promptbook_Server_Error {
7
- /**
8
- * The error message which caused the error
9
- */
10
- readonly errorMessage: string;
11
- }
1
+ /**
2
+ * Socket.io error for remote text generation
3
+ *
4
+ * This is sent from server to client when error occurs and stops the process
5
+ */
6
+ export interface Promptbook_Server_Error {
7
+ /**
8
+ * The error message which caused the error
9
+ */
10
+ readonly errorMessage: string;
11
+ }
@@ -1,12 +1,12 @@
1
- import type { TaskProgress } from '../../../types/TaskProgress';
2
- /**
3
- * Socket.io progress for remote text generation
4
- *
5
- * This is sent from server to client arbitrarily and may be sent multiple times
6
- */
7
- export interface Promptbook_Server_Progress {
8
- /**
9
- * The progress of text generation
10
- */
11
- readonly taskProgress: TaskProgress;
12
- }
1
+ import type { TaskProgress } from '../../../types/TaskProgress';
2
+ /**
3
+ * Socket.io progress for remote text generation
4
+ *
5
+ * This is sent from server to client arbitrarily and may be sent multiple times
6
+ */
7
+ export interface Promptbook_Server_Progress {
8
+ /**
9
+ * The progress of text generation
10
+ */
11
+ readonly taskProgress: TaskProgress;
12
+ }
@@ -1,17 +1,17 @@
1
- import type { Prompt } from '../../../types/Prompt';
2
- import type { client_id } from '../../../types/typeAliases';
3
- /**
4
- * Socket.io progress for remote text generation
5
- *
6
- * This is a request from client to server
7
- */
8
- export interface Promptbook_Server_Request {
9
- /**
10
- * Client responsible for the requests
11
- */
12
- readonly clientId: client_id;
13
- /**
14
- * The Prompt to execute
15
- */
16
- readonly prompt: Prompt;
17
- }
1
+ import type { Prompt } from '../../../types/Prompt';
2
+ import type { client_id } from '../../../types/typeAliases';
3
+ /**
4
+ * Socket.io progress for remote text generation
5
+ *
6
+ * This is a request from client to server
7
+ */
8
+ export interface Promptbook_Server_Request {
9
+ /**
10
+ * Client responsible for the requests
11
+ */
12
+ readonly clientId: client_id;
13
+ /**
14
+ * The Prompt to execute
15
+ */
16
+ readonly prompt: Prompt;
17
+ }
@@ -1,12 +1,12 @@
1
- import type { PromptResult } from '../../../execution/PromptResult';
2
- /**
3
- * Socket.io error for remote text generation
4
- *
5
- * This is sent from server to client when the generated text is completed
6
- */
7
- export interface Promptbook_Server_Response {
8
- /**
9
- * The result of the prompt
10
- */
11
- promptResult: PromptResult;
12
- }
1
+ import type { PromptResult } from '../../../execution/PromptResult';
2
+ /**
3
+ * Socket.io error for remote text generation
4
+ *
5
+ * This is sent from server to client when the generated text is completed
6
+ */
7
+ export interface Promptbook_Server_Response {
8
+ /**
9
+ * The result of the prompt
10
+ */
11
+ promptResult: PromptResult;
12
+ }
@@ -1,31 +1,37 @@
1
- import type { PipelineCollection } from '../../../collection/PipelineCollection';
2
- import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
3
- import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
4
- import type { client_id } from '../../../types/typeAliases';
5
- import type { string_uri } from '../../../types/typeAliases';
6
- export type RemoteServerOptions = CommonExecutionToolsOptions & {
7
- /**
8
- * Port on which the server will listen
9
- */
10
- readonly port: number;
11
- /**
12
- * Path for the Socket.io server to listen
13
- *
14
- * @default '/socket.io'
15
- * @example '/promptbook/socket.io'
16
- */
17
- readonly path: string_uri;
18
- /**
19
- * Promptbook collection to use
20
- *
21
- * This is used to check validity of the prompt to prevent DDoS
22
- */
23
- readonly collection: PipelineCollection;
24
- /**
25
- * Creates llm execution tools for each client
26
- */
27
- createLlmExecutionTools(clientId: client_id): LlmExecutionTools;
28
- };
29
- /**
30
- * TODO: [🍜] Add anonymous option
31
- */
1
+ import type { PipelineCollection } from '../../../collection/PipelineCollection';
2
+ import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
3
+ import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
4
+ import type { client_id } from '../../../types/typeAliases';
5
+ import type { string_uri } from '../../../types/typeAliases';
6
+ /**
7
+ * @@@
8
+ *
9
+ * @public exported from `@promptbook/remote-client`
10
+ * @public exported from `@promptbook/remote-server`
11
+ */
12
+ export type RemoteServerOptions = CommonExecutionToolsOptions & {
13
+ /**
14
+ * Port on which the server will listen
15
+ */
16
+ readonly port: number;
17
+ /**
18
+ * Path for the Socket.io server to listen
19
+ *
20
+ * @default '/socket.io'
21
+ * @example '/promptbook/socket.io'
22
+ */
23
+ readonly path: string_uri;
24
+ /**
25
+ * Promptbook collection to use
26
+ *
27
+ * This is used to check validity of the prompt to prevent DDoS
28
+ */
29
+ readonly collection: PipelineCollection;
30
+ /**
31
+ * Creates llm execution tools for each client
32
+ */
33
+ createLlmExecutionTools(clientId: client_id): LlmExecutionTools;
34
+ };
35
+ /**
36
+ * TODO: [🍜] Add anonymous option
37
+ */
@@ -1,20 +1,21 @@
1
- import type { IDestroyable } from 'destroyable';
2
- import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
3
- /**
4
- * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
5
- *
6
- * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
7
- * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
8
- *
9
- * @see https://github.com/webgptorg/promptbook#remote-server
10
- */
11
- export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
12
- /**
13
- * TODO: [🍜] Add anonymous option
14
- * TODO: [] Expose the collection to be able to connect to same collection via createCollectionFromUrl
15
- * TODO: Handle progress - support streaming
16
- * TODO: [🗯] Do not hang up immediately but wait until client closes OR timeout
17
- * TODO: [🗯] Timeout on chat to free up resources
18
- * TODO: [🃏] Pass here some security token to prevent malitious usage and/or DDoS
19
- * TODO: [0] Set unavailable models as undefined in `RemoteLlmExecutionTools` NOT throw error here
20
- */
1
+ import type { IDestroyable } from 'destroyable';
2
+ import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
3
+ /**
4
+ * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
5
+ *
6
+ * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
7
+ * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
8
+ *
9
+ * @see https://github.com/webgptorg/promptbook#remote-server
10
+ * @public exported from `@promptbook/remote-server`
11
+ */
12
+ export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
13
+ /**
14
+ * TODO: [🍜] Add anonymous option
15
+ * TODO: [⚖] Expose the collection to be able to connect to same collection via createCollectionFromUrl
16
+ * TODO: Handle progress - support streaming
17
+ * TODO: [🗯] Do not hang up immediately but wait until client closes OR timeout
18
+ * TODO: [🗯] Timeout on chat to free up resources
19
+ * TODO: [🃏] Pass here some security token to prevent malitious usage and/or DDoS
20
+ * TODO: [0] Set unavailable models as undefined in `RemoteLlmExecutionTools` NOT throw error here
21
+ */
@@ -1,15 +1,15 @@
1
- import type { PrepareOptions } from '../prepare/PrepareOptions';
2
- import type { PersonaPreparedJson } from '../types/PipelineJson/PersonaJson';
3
- import type { string_persona_description } from '../types/typeAliases';
4
- /**
5
- * Prepares the persona for the pipeline
6
- *
7
- * @see https://github.com/webgptorg/promptbook/discussions/22
8
- */
9
- export declare function preparePersona(personaDescription: string_persona_description, options: PrepareOptions): Promise<PersonaPreparedJson['modelRequirements']>;
10
- /**
11
- * TODO: [🔼] !!! Export via `@promptbook/core`
12
- * TODO: [🏢] !! Check validity of `modelName` in pipeline
13
- * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
14
- * TODO: [🏢] !! Check validity of `temperature` in pipeline
15
- */
1
+ import type { PrepareOptions } from '../prepare/PrepareOptions';
2
+ import type { PersonaPreparedJson } from '../types/PipelineJson/PersonaJson';
3
+ import type { string_persona_description } from '../types/typeAliases';
4
+ /**
5
+ * Prepares the persona for the pipeline
6
+ *
7
+ * @see https://github.com/webgptorg/promptbook/discussions/22
8
+ * @public exported from `@promptbook/core`
9
+ */
10
+ export declare function preparePersona(personaDescription: string_persona_description, options: PrepareOptions): Promise<PersonaPreparedJson['modelRequirements']>;
11
+ /**
12
+ * TODO: [🏢] !! Check validity of `modelName` in pipeline
13
+ * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
14
+ * TODO: [🏢] !! Check validity of `temperature` in pipeline
15
+ */
@@ -1 +1 @@
1
- export {};
1
+ export {};