@promptbook/node 0.56.0-3

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 (534) hide show
  1. package/README.md +706 -0
  2. package/esm/index.es.js +2491 -0
  3. package/esm/index.es.js.map +1 -0
  4. package/esm/typings/_packages/anthropic-claude.index.d.ts +5 -0
  5. package/esm/typings/_packages/azure-openai.index.d.ts +5 -0
  6. package/esm/typings/_packages/cli.index.d.ts +10 -0
  7. package/esm/typings/_packages/core.index.d.ts +41 -0
  8. package/esm/typings/_packages/execute-javascript.index.d.ts +48 -0
  9. package/esm/typings/_packages/fake-llm.index.d.ts +7 -0
  10. package/esm/typings/_packages/langtail.index.d.ts +5 -0
  11. package/esm/typings/_packages/node.index.d.ts +4 -0
  12. package/esm/typings/_packages/openai.index.d.ts +6 -0
  13. package/esm/typings/_packages/remote-client.index.d.ts +6 -0
  14. package/esm/typings/_packages/remote-server.index.d.ts +5 -0
  15. package/esm/typings/_packages/types.index.d.ts +28 -0
  16. package/esm/typings/_packages/utils.index.d.ts +71 -0
  17. package/esm/typings/config.d.ts +8 -0
  18. package/esm/typings/conversion/prettify/PrettifyOptions.d.ts +13 -0
  19. package/esm/typings/conversion/prettify/prettifyPromptbookString.d.ts +10 -0
  20. package/esm/typings/conversion/prettify/prettifyPromptbookStringCli.d.ts +9 -0
  21. package/esm/typings/conversion/prettify/renderPromptbookMermaid.d.ts +25 -0
  22. package/esm/typings/conversion/promptbookJsonToString.d.ts +12 -0
  23. package/esm/typings/conversion/promptbookStringToJson.d.ts +15 -0
  24. package/esm/typings/conversion/promptbookStringToJson.test.d.ts +1 -0
  25. package/esm/typings/conversion/utils/extractParametersFromPromptTemplate.d.ts +13 -0
  26. package/esm/typings/conversion/utils/extractParametersFromPromptTemplate.test.d.ts +1 -0
  27. package/esm/typings/conversion/utils/extractVariables.d.ts +13 -0
  28. package/esm/typings/conversion/utils/extractVariables.test.d.ts +1 -0
  29. package/esm/typings/conversion/utils/parseCommand.d.ts +11 -0
  30. package/esm/typings/conversion/utils/parseCommand.test.d.ts +4 -0
  31. package/esm/typings/conversion/utils/parseNumber.d.ts +15 -0
  32. package/esm/typings/conversion/utils/parseNumber.test.d.ts +1 -0
  33. package/esm/typings/conversion/utils/renameParameter.d.ts +25 -0
  34. package/esm/typings/conversion/utils/renameParameter.test.d.ts +1 -0
  35. package/esm/typings/conversion/utils/titleToName.d.ts +4 -0
  36. package/esm/typings/conversion/utils/titleToName.test.d.ts +1 -0
  37. package/esm/typings/conversion/validation/_importPromptbook.d.ts +13 -0
  38. package/esm/typings/conversion/validation/promptbookStringToJson-syntaxErrors.test.d.ts +1 -0
  39. package/esm/typings/conversion/validation/validatePromptbookJson-logicErrors.test.d.ts +1 -0
  40. package/esm/typings/conversion/validation/validatePromptbookJson.d.ts +27 -0
  41. package/esm/typings/conversion/validation/validatePromptbookJson.test.d.ts +1 -0
  42. package/esm/typings/errors/PromptbookExecutionError.d.ts +7 -0
  43. package/esm/typings/errors/PromptbookLibraryError.d.ts +7 -0
  44. package/esm/typings/errors/PromptbookLogicError.d.ts +7 -0
  45. package/esm/typings/errors/PromptbookNotFoundError.d.ts +7 -0
  46. package/esm/typings/errors/PromptbookReferenceError.d.ts +7 -0
  47. package/esm/typings/errors/PromptbookSyntaxError.d.ts +7 -0
  48. package/esm/typings/errors/TemplateError.d.ts +9 -0
  49. package/esm/typings/errors/UnexpectedError.d.ts +7 -0
  50. package/esm/typings/errors/_ExpectError.d.ts +10 -0
  51. package/esm/typings/execution/CommonExecutionToolsOptions.d.ts +9 -0
  52. package/esm/typings/execution/ExecutionTools.d.ts +32 -0
  53. package/esm/typings/execution/LlmExecutionTools.d.ts +50 -0
  54. package/esm/typings/execution/PromptResult.d.ts +103 -0
  55. package/esm/typings/execution/PromptbookExecutor.d.ts +42 -0
  56. package/esm/typings/execution/ScriptExecutionTools.d.ts +38 -0
  57. package/esm/typings/execution/UserInterfaceTools.d.ts +46 -0
  58. package/esm/typings/execution/addPromptResultUsage.test.d.ts +1 -0
  59. package/esm/typings/execution/assertsExecutionSuccessful.d.ts +11 -0
  60. package/esm/typings/execution/createPromptbookExecutor.d.ts +42 -0
  61. package/esm/typings/execution/plugins/llm-execution-tools/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +43 -0
  62. package/esm/typings/execution/plugins/llm-execution-tools/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +8 -0
  63. package/esm/typings/execution/plugins/llm-execution-tools/anthropic-claude/anthropic-claude-models.d.ts +20 -0
  64. package/esm/typings/execution/plugins/llm-execution-tools/anthropic-claude/playground/playground.d.ts +2 -0
  65. package/esm/typings/execution/plugins/llm-execution-tools/azure-openai/AzureOpenAiExecutionTools.d.ts +42 -0
  66. package/esm/typings/execution/plugins/llm-execution-tools/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +35 -0
  67. package/esm/typings/execution/plugins/llm-execution-tools/azure-openai/playground/playground.d.ts +2 -0
  68. package/esm/typings/execution/plugins/llm-execution-tools/langtail/LangtailExecutionTools.d.ts +7 -0
  69. package/esm/typings/execution/plugins/llm-execution-tools/langtail/LangtailExecutionToolsOptions.d.ts +11 -0
  70. package/esm/typings/execution/plugins/llm-execution-tools/langtail/playground/playground.d.ts +2 -0
  71. package/esm/typings/execution/plugins/llm-execution-tools/mocked/MockedEchoLlmExecutionTools.d.ts +28 -0
  72. package/esm/typings/execution/plugins/llm-execution-tools/mocked/MockedFackedLlmExecutionTools.d.ts +25 -0
  73. package/esm/typings/execution/plugins/llm-execution-tools/mocked/fakeTextToExpectations.d.ts +14 -0
  74. package/esm/typings/execution/plugins/llm-execution-tools/mocked/fakeTextToExpectations.test.d.ts +1 -0
  75. package/esm/typings/execution/plugins/llm-execution-tools/mocked/faked-completion.test.d.ts +1 -0
  76. package/esm/typings/execution/plugins/llm-execution-tools/mocked/joker.test.d.ts +4 -0
  77. package/esm/typings/execution/plugins/llm-execution-tools/mocked/mocked-chat.test.d.ts +4 -0
  78. package/esm/typings/execution/plugins/llm-execution-tools/mocked/mocked-completion.test.d.ts +4 -0
  79. package/esm/typings/execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools.d.ts +37 -0
  80. package/esm/typings/execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionToolsOptions.d.ts +24 -0
  81. package/esm/typings/execution/plugins/llm-execution-tools/multiple/playground/playground.d.ts +2 -0
  82. package/esm/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools.d.ts +47 -0
  83. package/esm/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionToolsOptions.d.ts +18 -0
  84. package/esm/typings/execution/plugins/llm-execution-tools/openai/computeOpenaiUsage.d.ts +12 -0
  85. package/esm/typings/execution/plugins/llm-execution-tools/openai/computeUsage.d.ts +16 -0
  86. package/esm/typings/execution/plugins/llm-execution-tools/openai/computeUsage.test.d.ts +1 -0
  87. package/esm/typings/execution/plugins/llm-execution-tools/openai/openai-models.d.ts +26 -0
  88. package/esm/typings/execution/plugins/llm-execution-tools/openai/playground/playground.d.ts +2 -0
  89. package/esm/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts +42 -0
  90. package/esm/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionToolsOptions.d.ts +24 -0
  91. package/esm/typings/execution/plugins/llm-execution-tools/remote/interfaces/Promptbook_Server_Error.d.ts +11 -0
  92. package/esm/typings/execution/plugins/llm-execution-tools/remote/interfaces/Promptbook_Server_Progress.d.ts +12 -0
  93. package/esm/typings/execution/plugins/llm-execution-tools/remote/interfaces/Promptbook_Server_Request.d.ts +17 -0
  94. package/esm/typings/execution/plugins/llm-execution-tools/remote/interfaces/Promptbook_Server_Response.d.ts +12 -0
  95. package/esm/typings/execution/plugins/llm-execution-tools/remote/interfaces/RemoteServerOptions.d.ts +28 -0
  96. package/esm/typings/execution/plugins/llm-execution-tools/remote/startRemoteServer.d.ts +18 -0
  97. package/esm/typings/execution/plugins/script-execution-tools/custom-function-async.test.ts.test.d.ts +1 -0
  98. package/esm/typings/execution/plugins/script-execution-tools/custom-function-missing.test.d.ts +1 -0
  99. package/esm/typings/execution/plugins/script-execution-tools/custom-function-with-dependencies.test.d.ts +1 -0
  100. package/esm/typings/execution/plugins/script-execution-tools/custom-function.test.d.ts +1 -0
  101. package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.d.ts +20 -0
  102. package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -0
  103. package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools.d.ts +7 -0
  104. package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionToolsOptions.d.ts +26 -0
  105. package/esm/typings/execution/plugins/script-execution-tools/javascript/utils/preserve.d.ts +11 -0
  106. package/esm/typings/execution/plugins/script-execution-tools/javascript/utils/unknownToString.d.ts +7 -0
  107. package/esm/typings/execution/plugins/script-execution-tools/postprocessing.test.d.ts +1 -0
  108. package/esm/typings/execution/plugins/script-execution-tools/python/PythonExecutionTools.d.ts +16 -0
  109. package/esm/typings/execution/plugins/script-execution-tools/script-execution-errors.test.d.ts +1 -0
  110. package/esm/typings/execution/plugins/script-execution-tools/script-execution-tools.test.d.ts +1 -0
  111. package/esm/typings/execution/plugins/script-execution-tools/typescript/TypescriptExecutionTools.d.ts +16 -0
  112. package/esm/typings/execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools.d.ts +15 -0
  113. package/esm/typings/execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions.d.ts +12 -0
  114. package/esm/typings/execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools.d.ts +17 -0
  115. package/esm/typings/execution/plugins/user-interface-execution-tools/user-interface-execution-tools.test.d.ts +1 -0
  116. package/esm/typings/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +4 -0
  117. package/esm/typings/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +9 -0
  118. package/esm/typings/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +5 -0
  119. package/esm/typings/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +11 -0
  120. package/esm/typings/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +4 -0
  121. package/esm/typings/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +7 -0
  122. package/esm/typings/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts +1 -0
  123. package/esm/typings/execution/translation/automatic-translate/translateMessages.d.ts +5 -0
  124. package/esm/typings/execution/utils/addUsage.d.ts +7 -0
  125. package/esm/typings/execution/utils/addUsage.test.d.ts +1 -0
  126. package/esm/typings/execution/utils/checkExpectations.d.ts +25 -0
  127. package/esm/typings/execution/utils/checkExpectations.test.d.ts +1 -0
  128. package/esm/typings/execution/utils/computeUsageCounts.d.ts +10 -0
  129. package/esm/typings/execution/utils/forEachAsync.d.ts +18 -0
  130. package/esm/typings/execution/utils/replaceParameters.d.ts +13 -0
  131. package/esm/typings/execution/utils/replaceParameters.test.d.ts +1 -0
  132. package/esm/typings/execution/utils/uncertainNumber.d.ts +9 -0
  133. package/esm/typings/execution/utils/usageToWorktime.d.ts +10 -0
  134. package/esm/typings/execution/utils/usageToWorktime.test.d.ts +1 -0
  135. package/esm/typings/library/PromptbookLibrary.d.ts +25 -0
  136. package/esm/typings/library/SimplePromptbookLibrary.d.ts +36 -0
  137. package/esm/typings/library/constructors/createPromptbookLibraryFromDirectory.d.ts +43 -0
  138. package/esm/typings/library/constructors/createPromptbookLibraryFromDirectory.test.d.ts +1 -0
  139. package/esm/typings/library/constructors/createPromptbookLibraryFromPromise.d.ts +23 -0
  140. package/esm/typings/library/constructors/createPromptbookLibraryFromPromise.test.d.ts +1 -0
  141. package/esm/typings/library/constructors/createPromptbookLibraryFromSources.d.ts +13 -0
  142. package/esm/typings/library/constructors/createPromptbookLibraryFromSources.test.d.ts +1 -0
  143. package/esm/typings/library/constructors/createPromptbookLibraryFromUrl.d.ts +26 -0
  144. package/esm/typings/library/constructors/createPromptbookSublibrary.d.ts +12 -0
  145. package/esm/typings/library/constructors/justTestFsImport.d.ts +7 -0
  146. package/esm/typings/types/Command.d.ts +101 -0
  147. package/esm/typings/types/ExecutionTypes.d.ts +13 -0
  148. package/esm/typings/types/ModelRequirements.d.ts +43 -0
  149. package/esm/typings/types/Parameters.d.ts +14 -0
  150. package/esm/typings/types/Prompt.d.ts +57 -0
  151. package/esm/typings/types/PromptbookJson/PromptTemplateJson.d.ts +145 -0
  152. package/esm/typings/types/PromptbookJson/PromptTemplateParameterJson.d.ts +26 -0
  153. package/esm/typings/types/PromptbookJson/PromptbookJson.d.ts +53 -0
  154. package/esm/typings/types/PromptbookString.d.ts +12 -0
  155. package/esm/typings/types/ScriptLanguage.d.ts +9 -0
  156. package/esm/typings/types/TaskProgress.d.ts +43 -0
  157. package/esm/typings/types/execution-report/ExecutionReportJson.d.ts +58 -0
  158. package/esm/typings/types/execution-report/ExecutionReportString.d.ts +16 -0
  159. package/esm/typings/types/execution-report/ExecutionReportStringOptions.d.ts +21 -0
  160. package/esm/typings/types/execution-report/config.d.ts +8 -0
  161. package/esm/typings/types/execution-report/countWorkingDuration.d.ts +7 -0
  162. package/esm/typings/types/execution-report/countWorkingDuration.test.d.ts +1 -0
  163. package/esm/typings/types/execution-report/executionReportJsonToString.d.ts +11 -0
  164. package/esm/typings/types/execution-report/executionReportJsonToString.test.d.ts +1 -0
  165. package/esm/typings/types/typeAliasEmoji.d.ts +9 -0
  166. package/esm/typings/types/typeAliases.d.ts +430 -0
  167. package/esm/typings/utils/FromtoItems.d.ts +19 -0
  168. package/esm/typings/utils/emojis.d.ts +22 -0
  169. package/esm/typings/utils/expectation-counters/countCharacters.d.ts +5 -0
  170. package/esm/typings/utils/expectation-counters/countCharacters.test.d.ts +1 -0
  171. package/esm/typings/utils/expectation-counters/countLines.d.ts +5 -0
  172. package/esm/typings/utils/expectation-counters/countLines.test.d.ts +1 -0
  173. package/esm/typings/utils/expectation-counters/countPages.d.ts +5 -0
  174. package/esm/typings/utils/expectation-counters/countPages.test.d.ts +1 -0
  175. package/esm/typings/utils/expectation-counters/countParagraphs.d.ts +5 -0
  176. package/esm/typings/utils/expectation-counters/countParagraphs.test.d.ts +1 -0
  177. package/esm/typings/utils/expectation-counters/countSentences.d.ts +9 -0
  178. package/esm/typings/utils/expectation-counters/countSentences.test.d.ts +1 -0
  179. package/esm/typings/utils/expectation-counters/countWords.d.ts +5 -0
  180. package/esm/typings/utils/expectation-counters/countWords.test.d.ts +1 -0
  181. package/esm/typings/utils/expectation-counters/index.d.ts +6 -0
  182. package/esm/typings/utils/extractParameters.d.ts +9 -0
  183. package/esm/typings/utils/extractParameters.test.d.ts +1 -0
  184. package/esm/typings/utils/formatNumber.d.ts +6 -0
  185. package/esm/typings/utils/formatNumber.test.d.ts +1 -0
  186. package/esm/typings/utils/getCurrentIsoDate.d.ts +7 -0
  187. package/esm/typings/utils/isRunningInWhatever.d.ts +12 -0
  188. package/esm/typings/utils/isValidJsonString.d.ts +4 -0
  189. package/esm/typings/utils/isValidJsonString.test.d.ts +1 -0
  190. package/esm/typings/utils/just.d.ts +10 -0
  191. package/esm/typings/utils/markdown/addAutoGeneratedSection.d.ts +11 -0
  192. package/esm/typings/utils/markdown/addAutoGeneratedSection.test.d.ts +1 -0
  193. package/esm/typings/utils/markdown/createMarkdownChart.d.ts +41 -0
  194. package/esm/typings/utils/markdown/createMarkdownChart.test.d.ts +1 -0
  195. package/esm/typings/utils/markdown/createMarkdownTable.d.ts +8 -0
  196. package/esm/typings/utils/markdown/createMarkdownTable.test.d.ts +1 -0
  197. package/esm/typings/utils/markdown/escapeMarkdownBlock.d.ts +6 -0
  198. package/esm/typings/utils/markdown/escapeMarkdownBlock.test.d.ts +1 -0
  199. package/esm/typings/utils/markdown/extractAllBlocksFromMarkdown.d.ts +27 -0
  200. package/esm/typings/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts +1 -0
  201. package/esm/typings/utils/markdown/extractAllListItemsFromMarkdown.d.ts +14 -0
  202. package/esm/typings/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts +1 -0
  203. package/esm/typings/utils/markdown/extractOneBlockFromMarkdown.d.ts +19 -0
  204. package/esm/typings/utils/markdown/extractOneBlockFromMarkdown.test.d.ts +1 -0
  205. package/esm/typings/utils/markdown/prettifyMarkdown.d.ts +8 -0
  206. package/esm/typings/utils/markdown/prettifyMarkdown.test.d.ts +1 -0
  207. package/esm/typings/utils/markdown/removeContentComments.d.ts +9 -0
  208. package/esm/typings/utils/markdown/removeContentComments.test.d.ts +1 -0
  209. package/esm/typings/utils/markdown/removeMarkdownFormatting.d.ts +8 -0
  210. package/esm/typings/utils/markdown/removeMarkdownFormatting.test.d.ts +1 -0
  211. package/esm/typings/utils/markdown-json/MarkdownStructure.d.ts +25 -0
  212. package/esm/typings/utils/markdown-json/countMarkdownStructureDeepness.d.ts +7 -0
  213. package/esm/typings/utils/markdown-json/countMarkdownStructureDeepness.test.d.ts +1 -0
  214. package/esm/typings/utils/markdown-json/markdownToMarkdownStructure.d.ts +13 -0
  215. package/esm/typings/utils/markdown-json/markdownToMarkdownStructure.test.d.ts +1 -0
  216. package/esm/typings/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts +10 -0
  217. package/esm/typings/utils/normalization/IKeywords.d.ts +18 -0
  218. package/esm/typings/utils/normalization/capitalize.d.ts +5 -0
  219. package/esm/typings/utils/normalization/capitalize.test.d.ts +1 -0
  220. package/esm/typings/utils/normalization/decapitalize.d.ts +5 -0
  221. package/esm/typings/utils/normalization/decapitalize.test.d.ts +1 -0
  222. package/esm/typings/utils/normalization/isValidKeyword.d.ts +8 -0
  223. package/esm/typings/utils/normalization/isValidKeyword.test.d.ts +1 -0
  224. package/esm/typings/utils/normalization/nameToUriPart.d.ts +1 -0
  225. package/esm/typings/utils/normalization/nameToUriPart.test.d.ts +1 -0
  226. package/esm/typings/utils/normalization/nameToUriParts.d.ts +1 -0
  227. package/esm/typings/utils/normalization/nameToUriParts.test.d.ts +1 -0
  228. package/esm/typings/utils/normalization/normalize-to-kebab-case.d.ts +1 -0
  229. package/esm/typings/utils/normalization/normalize-to-kebab-case.test.d.ts +1 -0
  230. package/esm/typings/utils/normalization/normalizeTo_PascalCase.d.ts +1 -0
  231. package/esm/typings/utils/normalization/normalizeTo_PascalCase.test.d.ts +1 -0
  232. package/esm/typings/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +4 -0
  233. package/esm/typings/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts +1 -0
  234. package/esm/typings/utils/normalization/normalizeTo_camelCase.d.ts +4 -0
  235. package/esm/typings/utils/normalization/normalizeTo_camelCase.test.d.ts +1 -0
  236. package/esm/typings/utils/normalization/normalizeTo_snake_case.d.ts +1 -0
  237. package/esm/typings/utils/normalization/normalizeTo_snake_case.test.d.ts +1 -0
  238. package/esm/typings/utils/normalization/normalizeWhitespaces.d.ts +4 -0
  239. package/esm/typings/utils/normalization/normalizeWhitespaces.test.d.ts +1 -0
  240. package/esm/typings/utils/normalization/parseKeywords.d.ts +14 -0
  241. package/esm/typings/utils/normalization/parseKeywords.test.d.ts +1 -0
  242. package/esm/typings/utils/normalization/parseKeywordsFromString.d.ts +8 -0
  243. package/esm/typings/utils/normalization/parseKeywordsFromString.test.d.ts +1 -0
  244. package/esm/typings/utils/normalization/removeDiacritics.d.ts +4 -0
  245. package/esm/typings/utils/normalization/removeDiacritics.test.d.ts +1 -0
  246. package/esm/typings/utils/normalization/searchKeywords.d.ts +5 -0
  247. package/esm/typings/utils/normalization/searchKeywords.test.d.ts +1 -0
  248. package/esm/typings/utils/postprocessing/extractBlock.d.ts +12 -0
  249. package/esm/typings/utils/removeEmojis.d.ts +7 -0
  250. package/esm/typings/utils/removeEmojis.test.d.ts +1 -0
  251. package/esm/typings/utils/removeQuotes.d.ts +13 -0
  252. package/esm/typings/utils/removeQuotes.test.d.ts +1 -0
  253. package/esm/typings/utils/sets/difference.d.ts +4 -0
  254. package/esm/typings/utils/sets/difference.test.d.ts +1 -0
  255. package/esm/typings/utils/sets/intersection.d.ts +4 -0
  256. package/esm/typings/utils/sets/intersection.test.d.ts +1 -0
  257. package/esm/typings/utils/sets/union.d.ts +4 -0
  258. package/esm/typings/utils/sets/union.test.d.ts +1 -0
  259. package/esm/typings/utils/trimCodeBlock.d.ts +8 -0
  260. package/esm/typings/utils/trimCodeBlock.test.d.ts +1 -0
  261. package/esm/typings/utils/trimEndOfCodeBlock.d.ts +7 -0
  262. package/esm/typings/utils/trimEndOfCodeBlock.test.d.ts +1 -0
  263. package/esm/typings/utils/unwrapResult.d.ts +36 -0
  264. package/esm/typings/utils/unwrapResult.test.d.ts +1 -0
  265. package/esm/typings/utils/validators/url/isValidUrl.d.ts +7 -0
  266. package/esm/typings/utils/validators/url/isValidUrl.test.d.ts +1 -0
  267. package/esm/typings/version.d.ts +5 -0
  268. package/package.json +56 -0
  269. package/umd/index.umd.js +2501 -0
  270. package/umd/index.umd.js.map +1 -0
  271. package/umd/typings/_packages/anthropic-claude.index.d.ts +5 -0
  272. package/umd/typings/_packages/azure-openai.index.d.ts +5 -0
  273. package/umd/typings/_packages/cli.index.d.ts +10 -0
  274. package/umd/typings/_packages/core.index.d.ts +41 -0
  275. package/umd/typings/_packages/execute-javascript.index.d.ts +48 -0
  276. package/umd/typings/_packages/fake-llm.index.d.ts +7 -0
  277. package/umd/typings/_packages/langtail.index.d.ts +5 -0
  278. package/umd/typings/_packages/node.index.d.ts +4 -0
  279. package/umd/typings/_packages/openai.index.d.ts +6 -0
  280. package/umd/typings/_packages/remote-client.index.d.ts +6 -0
  281. package/umd/typings/_packages/remote-server.index.d.ts +5 -0
  282. package/umd/typings/_packages/types.index.d.ts +28 -0
  283. package/umd/typings/_packages/utils.index.d.ts +71 -0
  284. package/umd/typings/config.d.ts +8 -0
  285. package/umd/typings/conversion/prettify/PrettifyOptions.d.ts +13 -0
  286. package/umd/typings/conversion/prettify/prettifyPromptbookString.d.ts +10 -0
  287. package/umd/typings/conversion/prettify/prettifyPromptbookStringCli.d.ts +9 -0
  288. package/umd/typings/conversion/prettify/renderPromptbookMermaid.d.ts +25 -0
  289. package/umd/typings/conversion/promptbookJsonToString.d.ts +12 -0
  290. package/umd/typings/conversion/promptbookStringToJson.d.ts +15 -0
  291. package/umd/typings/conversion/promptbookStringToJson.test.d.ts +1 -0
  292. package/umd/typings/conversion/utils/extractParametersFromPromptTemplate.d.ts +13 -0
  293. package/umd/typings/conversion/utils/extractParametersFromPromptTemplate.test.d.ts +1 -0
  294. package/umd/typings/conversion/utils/extractVariables.d.ts +13 -0
  295. package/umd/typings/conversion/utils/extractVariables.test.d.ts +1 -0
  296. package/umd/typings/conversion/utils/parseCommand.d.ts +11 -0
  297. package/umd/typings/conversion/utils/parseCommand.test.d.ts +4 -0
  298. package/umd/typings/conversion/utils/parseNumber.d.ts +15 -0
  299. package/umd/typings/conversion/utils/parseNumber.test.d.ts +1 -0
  300. package/umd/typings/conversion/utils/renameParameter.d.ts +25 -0
  301. package/umd/typings/conversion/utils/renameParameter.test.d.ts +1 -0
  302. package/umd/typings/conversion/utils/titleToName.d.ts +4 -0
  303. package/umd/typings/conversion/utils/titleToName.test.d.ts +1 -0
  304. package/umd/typings/conversion/validation/_importPromptbook.d.ts +13 -0
  305. package/umd/typings/conversion/validation/promptbookStringToJson-syntaxErrors.test.d.ts +1 -0
  306. package/umd/typings/conversion/validation/validatePromptbookJson-logicErrors.test.d.ts +1 -0
  307. package/umd/typings/conversion/validation/validatePromptbookJson.d.ts +27 -0
  308. package/umd/typings/conversion/validation/validatePromptbookJson.test.d.ts +1 -0
  309. package/umd/typings/errors/PromptbookExecutionError.d.ts +7 -0
  310. package/umd/typings/errors/PromptbookLibraryError.d.ts +7 -0
  311. package/umd/typings/errors/PromptbookLogicError.d.ts +7 -0
  312. package/umd/typings/errors/PromptbookNotFoundError.d.ts +7 -0
  313. package/umd/typings/errors/PromptbookReferenceError.d.ts +7 -0
  314. package/umd/typings/errors/PromptbookSyntaxError.d.ts +7 -0
  315. package/umd/typings/errors/TemplateError.d.ts +9 -0
  316. package/umd/typings/errors/UnexpectedError.d.ts +7 -0
  317. package/umd/typings/errors/_ExpectError.d.ts +10 -0
  318. package/umd/typings/execution/CommonExecutionToolsOptions.d.ts +9 -0
  319. package/umd/typings/execution/ExecutionTools.d.ts +32 -0
  320. package/umd/typings/execution/LlmExecutionTools.d.ts +50 -0
  321. package/umd/typings/execution/PromptResult.d.ts +103 -0
  322. package/umd/typings/execution/PromptbookExecutor.d.ts +42 -0
  323. package/umd/typings/execution/ScriptExecutionTools.d.ts +38 -0
  324. package/umd/typings/execution/UserInterfaceTools.d.ts +46 -0
  325. package/umd/typings/execution/addPromptResultUsage.test.d.ts +1 -0
  326. package/umd/typings/execution/assertsExecutionSuccessful.d.ts +11 -0
  327. package/umd/typings/execution/createPromptbookExecutor.d.ts +42 -0
  328. package/umd/typings/execution/plugins/llm-execution-tools/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +43 -0
  329. package/umd/typings/execution/plugins/llm-execution-tools/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +8 -0
  330. package/umd/typings/execution/plugins/llm-execution-tools/anthropic-claude/anthropic-claude-models.d.ts +20 -0
  331. package/umd/typings/execution/plugins/llm-execution-tools/anthropic-claude/playground/playground.d.ts +2 -0
  332. package/umd/typings/execution/plugins/llm-execution-tools/azure-openai/AzureOpenAiExecutionTools.d.ts +42 -0
  333. package/umd/typings/execution/plugins/llm-execution-tools/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +35 -0
  334. package/umd/typings/execution/plugins/llm-execution-tools/azure-openai/playground/playground.d.ts +2 -0
  335. package/umd/typings/execution/plugins/llm-execution-tools/langtail/LangtailExecutionTools.d.ts +7 -0
  336. package/umd/typings/execution/plugins/llm-execution-tools/langtail/LangtailExecutionToolsOptions.d.ts +11 -0
  337. package/umd/typings/execution/plugins/llm-execution-tools/langtail/playground/playground.d.ts +2 -0
  338. package/umd/typings/execution/plugins/llm-execution-tools/mocked/MockedEchoLlmExecutionTools.d.ts +28 -0
  339. package/umd/typings/execution/plugins/llm-execution-tools/mocked/MockedFackedLlmExecutionTools.d.ts +25 -0
  340. package/umd/typings/execution/plugins/llm-execution-tools/mocked/fakeTextToExpectations.d.ts +14 -0
  341. package/umd/typings/execution/plugins/llm-execution-tools/mocked/fakeTextToExpectations.test.d.ts +1 -0
  342. package/umd/typings/execution/plugins/llm-execution-tools/mocked/faked-completion.test.d.ts +1 -0
  343. package/umd/typings/execution/plugins/llm-execution-tools/mocked/joker.test.d.ts +4 -0
  344. package/umd/typings/execution/plugins/llm-execution-tools/mocked/mocked-chat.test.d.ts +4 -0
  345. package/umd/typings/execution/plugins/llm-execution-tools/mocked/mocked-completion.test.d.ts +4 -0
  346. package/umd/typings/execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools.d.ts +37 -0
  347. package/umd/typings/execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionToolsOptions.d.ts +24 -0
  348. package/umd/typings/execution/plugins/llm-execution-tools/multiple/playground/playground.d.ts +2 -0
  349. package/umd/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools.d.ts +47 -0
  350. package/umd/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionToolsOptions.d.ts +18 -0
  351. package/umd/typings/execution/plugins/llm-execution-tools/openai/computeOpenaiUsage.d.ts +12 -0
  352. package/umd/typings/execution/plugins/llm-execution-tools/openai/computeUsage.d.ts +16 -0
  353. package/umd/typings/execution/plugins/llm-execution-tools/openai/computeUsage.test.d.ts +1 -0
  354. package/umd/typings/execution/plugins/llm-execution-tools/openai/openai-models.d.ts +26 -0
  355. package/umd/typings/execution/plugins/llm-execution-tools/openai/playground/playground.d.ts +2 -0
  356. package/umd/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts +42 -0
  357. package/umd/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionToolsOptions.d.ts +24 -0
  358. package/umd/typings/execution/plugins/llm-execution-tools/remote/interfaces/Promptbook_Server_Error.d.ts +11 -0
  359. package/umd/typings/execution/plugins/llm-execution-tools/remote/interfaces/Promptbook_Server_Progress.d.ts +12 -0
  360. package/umd/typings/execution/plugins/llm-execution-tools/remote/interfaces/Promptbook_Server_Request.d.ts +17 -0
  361. package/umd/typings/execution/plugins/llm-execution-tools/remote/interfaces/Promptbook_Server_Response.d.ts +12 -0
  362. package/umd/typings/execution/plugins/llm-execution-tools/remote/interfaces/RemoteServerOptions.d.ts +28 -0
  363. package/umd/typings/execution/plugins/llm-execution-tools/remote/startRemoteServer.d.ts +18 -0
  364. package/umd/typings/execution/plugins/script-execution-tools/custom-function-async.test.ts.test.d.ts +1 -0
  365. package/umd/typings/execution/plugins/script-execution-tools/custom-function-missing.test.d.ts +1 -0
  366. package/umd/typings/execution/plugins/script-execution-tools/custom-function-with-dependencies.test.d.ts +1 -0
  367. package/umd/typings/execution/plugins/script-execution-tools/custom-function.test.d.ts +1 -0
  368. package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.d.ts +20 -0
  369. package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -0
  370. package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools.d.ts +7 -0
  371. package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionToolsOptions.d.ts +26 -0
  372. package/umd/typings/execution/plugins/script-execution-tools/javascript/utils/preserve.d.ts +11 -0
  373. package/umd/typings/execution/plugins/script-execution-tools/javascript/utils/unknownToString.d.ts +7 -0
  374. package/umd/typings/execution/plugins/script-execution-tools/postprocessing.test.d.ts +1 -0
  375. package/umd/typings/execution/plugins/script-execution-tools/python/PythonExecutionTools.d.ts +16 -0
  376. package/umd/typings/execution/plugins/script-execution-tools/script-execution-errors.test.d.ts +1 -0
  377. package/umd/typings/execution/plugins/script-execution-tools/script-execution-tools.test.d.ts +1 -0
  378. package/umd/typings/execution/plugins/script-execution-tools/typescript/TypescriptExecutionTools.d.ts +16 -0
  379. package/umd/typings/execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools.d.ts +15 -0
  380. package/umd/typings/execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions.d.ts +12 -0
  381. package/umd/typings/execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools.d.ts +17 -0
  382. package/umd/typings/execution/plugins/user-interface-execution-tools/user-interface-execution-tools.test.d.ts +1 -0
  383. package/umd/typings/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +4 -0
  384. package/umd/typings/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +9 -0
  385. package/umd/typings/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +5 -0
  386. package/umd/typings/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +11 -0
  387. package/umd/typings/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +4 -0
  388. package/umd/typings/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +7 -0
  389. package/umd/typings/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts +1 -0
  390. package/umd/typings/execution/translation/automatic-translate/translateMessages.d.ts +5 -0
  391. package/umd/typings/execution/utils/addUsage.d.ts +7 -0
  392. package/umd/typings/execution/utils/addUsage.test.d.ts +1 -0
  393. package/umd/typings/execution/utils/checkExpectations.d.ts +25 -0
  394. package/umd/typings/execution/utils/checkExpectations.test.d.ts +1 -0
  395. package/umd/typings/execution/utils/computeUsageCounts.d.ts +10 -0
  396. package/umd/typings/execution/utils/forEachAsync.d.ts +18 -0
  397. package/umd/typings/execution/utils/replaceParameters.d.ts +13 -0
  398. package/umd/typings/execution/utils/replaceParameters.test.d.ts +1 -0
  399. package/umd/typings/execution/utils/uncertainNumber.d.ts +9 -0
  400. package/umd/typings/execution/utils/usageToWorktime.d.ts +10 -0
  401. package/umd/typings/execution/utils/usageToWorktime.test.d.ts +1 -0
  402. package/umd/typings/library/PromptbookLibrary.d.ts +25 -0
  403. package/umd/typings/library/SimplePromptbookLibrary.d.ts +36 -0
  404. package/umd/typings/library/constructors/createPromptbookLibraryFromDirectory.d.ts +43 -0
  405. package/umd/typings/library/constructors/createPromptbookLibraryFromDirectory.test.d.ts +1 -0
  406. package/umd/typings/library/constructors/createPromptbookLibraryFromPromise.d.ts +23 -0
  407. package/umd/typings/library/constructors/createPromptbookLibraryFromPromise.test.d.ts +1 -0
  408. package/umd/typings/library/constructors/createPromptbookLibraryFromSources.d.ts +13 -0
  409. package/umd/typings/library/constructors/createPromptbookLibraryFromSources.test.d.ts +1 -0
  410. package/umd/typings/library/constructors/createPromptbookLibraryFromUrl.d.ts +26 -0
  411. package/umd/typings/library/constructors/createPromptbookSublibrary.d.ts +12 -0
  412. package/umd/typings/library/constructors/justTestFsImport.d.ts +7 -0
  413. package/umd/typings/types/Command.d.ts +101 -0
  414. package/umd/typings/types/ExecutionTypes.d.ts +13 -0
  415. package/umd/typings/types/ModelRequirements.d.ts +43 -0
  416. package/umd/typings/types/Parameters.d.ts +14 -0
  417. package/umd/typings/types/Prompt.d.ts +57 -0
  418. package/umd/typings/types/PromptbookJson/PromptTemplateJson.d.ts +145 -0
  419. package/umd/typings/types/PromptbookJson/PromptTemplateParameterJson.d.ts +26 -0
  420. package/umd/typings/types/PromptbookJson/PromptbookJson.d.ts +53 -0
  421. package/umd/typings/types/PromptbookString.d.ts +12 -0
  422. package/umd/typings/types/ScriptLanguage.d.ts +9 -0
  423. package/umd/typings/types/TaskProgress.d.ts +43 -0
  424. package/umd/typings/types/execution-report/ExecutionReportJson.d.ts +58 -0
  425. package/umd/typings/types/execution-report/ExecutionReportString.d.ts +16 -0
  426. package/umd/typings/types/execution-report/ExecutionReportStringOptions.d.ts +21 -0
  427. package/umd/typings/types/execution-report/config.d.ts +8 -0
  428. package/umd/typings/types/execution-report/countWorkingDuration.d.ts +7 -0
  429. package/umd/typings/types/execution-report/countWorkingDuration.test.d.ts +1 -0
  430. package/umd/typings/types/execution-report/executionReportJsonToString.d.ts +11 -0
  431. package/umd/typings/types/execution-report/executionReportJsonToString.test.d.ts +1 -0
  432. package/umd/typings/types/typeAliasEmoji.d.ts +9 -0
  433. package/umd/typings/types/typeAliases.d.ts +430 -0
  434. package/umd/typings/utils/FromtoItems.d.ts +19 -0
  435. package/umd/typings/utils/emojis.d.ts +22 -0
  436. package/umd/typings/utils/expectation-counters/countCharacters.d.ts +5 -0
  437. package/umd/typings/utils/expectation-counters/countCharacters.test.d.ts +1 -0
  438. package/umd/typings/utils/expectation-counters/countLines.d.ts +5 -0
  439. package/umd/typings/utils/expectation-counters/countLines.test.d.ts +1 -0
  440. package/umd/typings/utils/expectation-counters/countPages.d.ts +5 -0
  441. package/umd/typings/utils/expectation-counters/countPages.test.d.ts +1 -0
  442. package/umd/typings/utils/expectation-counters/countParagraphs.d.ts +5 -0
  443. package/umd/typings/utils/expectation-counters/countParagraphs.test.d.ts +1 -0
  444. package/umd/typings/utils/expectation-counters/countSentences.d.ts +9 -0
  445. package/umd/typings/utils/expectation-counters/countSentences.test.d.ts +1 -0
  446. package/umd/typings/utils/expectation-counters/countWords.d.ts +5 -0
  447. package/umd/typings/utils/expectation-counters/countWords.test.d.ts +1 -0
  448. package/umd/typings/utils/expectation-counters/index.d.ts +6 -0
  449. package/umd/typings/utils/extractParameters.d.ts +9 -0
  450. package/umd/typings/utils/extractParameters.test.d.ts +1 -0
  451. package/umd/typings/utils/formatNumber.d.ts +6 -0
  452. package/umd/typings/utils/formatNumber.test.d.ts +1 -0
  453. package/umd/typings/utils/getCurrentIsoDate.d.ts +7 -0
  454. package/umd/typings/utils/isRunningInWhatever.d.ts +12 -0
  455. package/umd/typings/utils/isValidJsonString.d.ts +4 -0
  456. package/umd/typings/utils/isValidJsonString.test.d.ts +1 -0
  457. package/umd/typings/utils/just.d.ts +10 -0
  458. package/umd/typings/utils/markdown/addAutoGeneratedSection.d.ts +11 -0
  459. package/umd/typings/utils/markdown/addAutoGeneratedSection.test.d.ts +1 -0
  460. package/umd/typings/utils/markdown/createMarkdownChart.d.ts +41 -0
  461. package/umd/typings/utils/markdown/createMarkdownChart.test.d.ts +1 -0
  462. package/umd/typings/utils/markdown/createMarkdownTable.d.ts +8 -0
  463. package/umd/typings/utils/markdown/createMarkdownTable.test.d.ts +1 -0
  464. package/umd/typings/utils/markdown/escapeMarkdownBlock.d.ts +6 -0
  465. package/umd/typings/utils/markdown/escapeMarkdownBlock.test.d.ts +1 -0
  466. package/umd/typings/utils/markdown/extractAllBlocksFromMarkdown.d.ts +27 -0
  467. package/umd/typings/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts +1 -0
  468. package/umd/typings/utils/markdown/extractAllListItemsFromMarkdown.d.ts +14 -0
  469. package/umd/typings/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts +1 -0
  470. package/umd/typings/utils/markdown/extractOneBlockFromMarkdown.d.ts +19 -0
  471. package/umd/typings/utils/markdown/extractOneBlockFromMarkdown.test.d.ts +1 -0
  472. package/umd/typings/utils/markdown/prettifyMarkdown.d.ts +8 -0
  473. package/umd/typings/utils/markdown/prettifyMarkdown.test.d.ts +1 -0
  474. package/umd/typings/utils/markdown/removeContentComments.d.ts +9 -0
  475. package/umd/typings/utils/markdown/removeContentComments.test.d.ts +1 -0
  476. package/umd/typings/utils/markdown/removeMarkdownFormatting.d.ts +8 -0
  477. package/umd/typings/utils/markdown/removeMarkdownFormatting.test.d.ts +1 -0
  478. package/umd/typings/utils/markdown-json/MarkdownStructure.d.ts +25 -0
  479. package/umd/typings/utils/markdown-json/countMarkdownStructureDeepness.d.ts +7 -0
  480. package/umd/typings/utils/markdown-json/countMarkdownStructureDeepness.test.d.ts +1 -0
  481. package/umd/typings/utils/markdown-json/markdownToMarkdownStructure.d.ts +13 -0
  482. package/umd/typings/utils/markdown-json/markdownToMarkdownStructure.test.d.ts +1 -0
  483. package/umd/typings/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts +10 -0
  484. package/umd/typings/utils/normalization/IKeywords.d.ts +18 -0
  485. package/umd/typings/utils/normalization/capitalize.d.ts +5 -0
  486. package/umd/typings/utils/normalization/capitalize.test.d.ts +1 -0
  487. package/umd/typings/utils/normalization/decapitalize.d.ts +5 -0
  488. package/umd/typings/utils/normalization/decapitalize.test.d.ts +1 -0
  489. package/umd/typings/utils/normalization/isValidKeyword.d.ts +8 -0
  490. package/umd/typings/utils/normalization/isValidKeyword.test.d.ts +1 -0
  491. package/umd/typings/utils/normalization/nameToUriPart.d.ts +1 -0
  492. package/umd/typings/utils/normalization/nameToUriPart.test.d.ts +1 -0
  493. package/umd/typings/utils/normalization/nameToUriParts.d.ts +1 -0
  494. package/umd/typings/utils/normalization/nameToUriParts.test.d.ts +1 -0
  495. package/umd/typings/utils/normalization/normalize-to-kebab-case.d.ts +1 -0
  496. package/umd/typings/utils/normalization/normalize-to-kebab-case.test.d.ts +1 -0
  497. package/umd/typings/utils/normalization/normalizeTo_PascalCase.d.ts +1 -0
  498. package/umd/typings/utils/normalization/normalizeTo_PascalCase.test.d.ts +1 -0
  499. package/umd/typings/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +4 -0
  500. package/umd/typings/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts +1 -0
  501. package/umd/typings/utils/normalization/normalizeTo_camelCase.d.ts +4 -0
  502. package/umd/typings/utils/normalization/normalizeTo_camelCase.test.d.ts +1 -0
  503. package/umd/typings/utils/normalization/normalizeTo_snake_case.d.ts +1 -0
  504. package/umd/typings/utils/normalization/normalizeTo_snake_case.test.d.ts +1 -0
  505. package/umd/typings/utils/normalization/normalizeWhitespaces.d.ts +4 -0
  506. package/umd/typings/utils/normalization/normalizeWhitespaces.test.d.ts +1 -0
  507. package/umd/typings/utils/normalization/parseKeywords.d.ts +14 -0
  508. package/umd/typings/utils/normalization/parseKeywords.test.d.ts +1 -0
  509. package/umd/typings/utils/normalization/parseKeywordsFromString.d.ts +8 -0
  510. package/umd/typings/utils/normalization/parseKeywordsFromString.test.d.ts +1 -0
  511. package/umd/typings/utils/normalization/removeDiacritics.d.ts +4 -0
  512. package/umd/typings/utils/normalization/removeDiacritics.test.d.ts +1 -0
  513. package/umd/typings/utils/normalization/searchKeywords.d.ts +5 -0
  514. package/umd/typings/utils/normalization/searchKeywords.test.d.ts +1 -0
  515. package/umd/typings/utils/postprocessing/extractBlock.d.ts +12 -0
  516. package/umd/typings/utils/removeEmojis.d.ts +7 -0
  517. package/umd/typings/utils/removeEmojis.test.d.ts +1 -0
  518. package/umd/typings/utils/removeQuotes.d.ts +13 -0
  519. package/umd/typings/utils/removeQuotes.test.d.ts +1 -0
  520. package/umd/typings/utils/sets/difference.d.ts +4 -0
  521. package/umd/typings/utils/sets/difference.test.d.ts +1 -0
  522. package/umd/typings/utils/sets/intersection.d.ts +4 -0
  523. package/umd/typings/utils/sets/intersection.test.d.ts +1 -0
  524. package/umd/typings/utils/sets/union.d.ts +4 -0
  525. package/umd/typings/utils/sets/union.test.d.ts +1 -0
  526. package/umd/typings/utils/trimCodeBlock.d.ts +8 -0
  527. package/umd/typings/utils/trimCodeBlock.test.d.ts +1 -0
  528. package/umd/typings/utils/trimEndOfCodeBlock.d.ts +7 -0
  529. package/umd/typings/utils/trimEndOfCodeBlock.test.d.ts +1 -0
  530. package/umd/typings/utils/unwrapResult.d.ts +36 -0
  531. package/umd/typings/utils/unwrapResult.test.d.ts +1 -0
  532. package/umd/typings/utils/validators/url/isValidUrl.d.ts +7 -0
  533. package/umd/typings/utils/validators/url/isValidUrl.test.d.ts +1 -0
  534. package/umd/typings/version.d.ts +5 -0
@@ -0,0 +1,26 @@
1
+ import type { Promisable } from 'type-fest';
2
+ import type { string_javascript_name } from '../../../../types/typeAliases';
3
+ import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
4
+ /**
5
+ * Options for javascript execution
6
+ */
7
+ export type JavascriptExecutionToolsOptions = CommonExecutionToolsOptions & {
8
+ /**
9
+ * Functions to be executed in the JavaScript evaluation.
10
+ *
11
+ * This can be used in two ways:
12
+ * 1. To provide custom postprocessing functions. For this case function must receive one string and return a (promise of) string.
13
+ * 2. As environment for the ECECUTE SCRIPT, For this case function can be any function. [0]
14
+ *
15
+ * Note: There are also some built-in functions available:
16
+ * @see ./JavascriptEvalExecutionTools.ts
17
+ */
18
+ functions?: Record<string_javascript_name, PostprocessingFunction>;
19
+ };
20
+ /**
21
+ * Function that can be used to postprocess the output of the LLM
22
+ */
23
+ export type PostprocessingFunction = ((value: string) => Promisable<string>) | Function;
24
+ /**
25
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
26
+ */
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Does nothing, but preserves the function in the bundle
3
+ * Compiler is tricked into thinking the function is used
4
+ *
5
+ * @param value any function to preserve
6
+ * @returns nothing
7
+ */
8
+ export declare function preserve(func: (...params: Array<any>) => unknown): void;
9
+ /**
10
+ * TODO: !! [1] This maybe does memory leak
11
+ */
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Converts anything to string that can be used for debugging and logging
3
+ *
4
+ * @param value String value for logging
5
+ * @private Internal util
6
+ */
7
+ export declare function unknownToString(value: unknown): string;
@@ -0,0 +1,16 @@
1
+ import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
2
+ import type { ScriptExecutionTools } from '../../../ScriptExecutionTools';
3
+ import type { ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
4
+ /**
5
+ * ScriptExecutionTools for Python
6
+ *
7
+ * Warning: This is not implemented yet
8
+ */
9
+ export declare class PythonExecutionTools implements ScriptExecutionTools {
10
+ private readonly options;
11
+ constructor(options: CommonExecutionToolsOptions);
12
+ /**
13
+ * Executes a Python
14
+ */
15
+ execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
16
+ }
@@ -0,0 +1,16 @@
1
+ import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
2
+ import type { ScriptExecutionTools } from '../../../ScriptExecutionTools';
3
+ import type { ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
4
+ /**
5
+ * ScriptExecutionTools for TypeScript
6
+ *
7
+ * Warning: This is not implemented yet
8
+ */
9
+ export declare class TypescriptExecutionTools implements ScriptExecutionTools {
10
+ private readonly options;
11
+ constructor(options: CommonExecutionToolsOptions);
12
+ /**
13
+ * Executes a TypeScript
14
+ */
15
+ execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
16
+ }
@@ -0,0 +1,15 @@
1
+ import type { UserInterfaceTools } from '../../../UserInterfaceTools';
2
+ import type { UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
3
+ import type { CallbackInterfaceToolsOptions } from './CallbackInterfaceToolsOptions';
4
+ /**
5
+ * Delagates the user interaction to a async callback function
6
+ * You need to provide your own implementation of this callback function and its bind to UI.
7
+ */
8
+ export declare class CallbackInterfaceTools implements UserInterfaceTools {
9
+ private readonly options;
10
+ constructor(options: CallbackInterfaceToolsOptions);
11
+ /**
12
+ * Trigger the custom callback function
13
+ */
14
+ promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
15
+ }
@@ -0,0 +1,12 @@
1
+ import type { Promisable } from 'type-fest';
2
+ import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
3
+ import type { UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
4
+ /**
5
+ * Options for CallbackInterfaceTools
6
+ */
7
+ export type CallbackInterfaceToolsOptions = CommonExecutionToolsOptions & {
8
+ /**
9
+ * The callback function to be called when promptDialog is called
10
+ */
11
+ callback(prompt: UserInterfaceToolsPromptDialogOptions): Promisable<string>;
12
+ };
@@ -0,0 +1,17 @@
1
+ import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
2
+ import type { UserInterfaceTools } from '../../../UserInterfaceTools';
3
+ import type { UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
4
+ /**
5
+ * Wrapper around `window.prompt` synchronous function that interacts with the user via browser prompt
6
+ *
7
+ * Warning: It is used for testing and mocking
8
+ * **NOT intended to use in the production** due to its synchronous nature.
9
+ */
10
+ export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
11
+ private readonly options;
12
+ constructor(options: CommonExecutionToolsOptions);
13
+ /**
14
+ * Trigger window.PROMPT DIALOG
15
+ */
16
+ promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
17
+ }
@@ -0,0 +1,4 @@
1
+ import type { Promisable } from 'type-fest';
2
+ export type AutomaticTranslator = {
3
+ translate(message: string): Promisable<string>;
4
+ };
@@ -0,0 +1,9 @@
1
+ import type { AutomaticTranslator } from './AutomaticTranslator';
2
+ /**
3
+ * This will wrap an automatic translator and log each translation into the console
4
+ */
5
+ export declare class DebugAutomaticTranslator implements AutomaticTranslator {
6
+ private readonly automaticTranslator;
7
+ constructor(automaticTranslator: AutomaticTranslator);
8
+ translate(message: string): Promise<string>;
9
+ }
@@ -0,0 +1,5 @@
1
+ import type { AutomaticTranslator } from './AutomaticTranslator';
2
+ export declare class FakeAutomaticTranslator implements AutomaticTranslator {
3
+ constructor();
4
+ translate(message: string): string;
5
+ }
@@ -0,0 +1,11 @@
1
+ import type { AutomaticTranslator } from './AutomaticTranslator';
2
+ import type { TranslatorOptions } from './TranslatorOptions';
3
+ interface LindatAutomaticTranslatorOptions extends TranslatorOptions {
4
+ apiUrl: URL;
5
+ }
6
+ export declare class LindatAutomaticTranslator implements AutomaticTranslator {
7
+ private readonly options;
8
+ constructor(options: LindatAutomaticTranslatorOptions);
9
+ translate(message: string): Promise<string>;
10
+ }
11
+ export {};
@@ -0,0 +1,4 @@
1
+ export type TranslatorOptions = {
2
+ from: string;
3
+ to: string;
4
+ };
@@ -0,0 +1,7 @@
1
+ /**
2
+ *
3
+ * @param message
4
+ * @returns
5
+ * @throws {PromptbookExecutionError}
6
+ */
7
+ export declare function extractMultiplicatedOccurrence(message: string): string;
@@ -0,0 +1,5 @@
1
+ import type { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
2
+ import type { TranslatorOptions } from './automatic-translators/TranslatorOptions';
3
+ export declare function translateMessages({ automaticTranslator, from, to, }: {
4
+ automaticTranslator: AutomaticTranslator;
5
+ } & TranslatorOptions): Promise<void>;
@@ -0,0 +1,7 @@
1
+ import type { PromptResultUsage } from '../PromptResult';
2
+ /**
3
+ * Function `addUsage` will add multiple usages into one
4
+ *
5
+ * Note: If you provide 0 values, it returns void usage
6
+ */
7
+ export declare function addUsage(...usageItems: Array<PromptResultUsage>): PromptResultUsage;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,25 @@
1
+ import type { Expectations } from '../../types/PromptbookJson/PromptTemplateJson';
2
+ /**
3
+ * Function checkExpectations will check if the expectations on given value are met
4
+ *
5
+ * Note: There are two simmilar functions:
6
+ * - `checkExpectations` which throws an error if the expectations are not met
7
+ * - `isPassingExpectations` which returns a boolean
8
+ *
9
+ * @throws {ExpectError} if the expectations are not met
10
+ * @returns {void} Nothing
11
+ */
12
+ export declare function checkExpectations(expectations: Expectations, value: string): void;
13
+ /**
14
+ * Function checkExpectations will check if the expectations on given value are met
15
+ *
16
+ * Note: There are two simmilar functions:
17
+ * - `checkExpectations` which throws an error if the expectations are not met
18
+ * - `isPassingExpectations` which returns a boolean
19
+ *
20
+ * @returns {boolean} True if the expectations are met
21
+ */
22
+ export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
23
+ /**
24
+ * TODO: [💝] Unite object for expecting amount and format
25
+ */
@@ -0,0 +1,10 @@
1
+ import type { PromptResultUsageCounts } from '../PromptResult';
2
+ /**
3
+ * Helper of usage compute
4
+ *
5
+ * @param content the content of prompt or response
6
+ * @returns part of PromptResultUsageCounts
7
+ *
8
+ * @private internal util of LlmExecutionTools
9
+ */
10
+ export declare function computeUsageCounts(content: string): Omit<PromptResultUsageCounts, 'tokensCount'>;
@@ -0,0 +1,18 @@
1
+ import type { Promisable } from 'type-fest';
2
+ type ForEachAsyncOptions = {
3
+ /**
4
+ * Maximum number of tasks running in parallel
5
+ *
6
+ * @default Infinity
7
+ */
8
+ inParallelCount?: number;
9
+ };
10
+ /**
11
+ * Async version of Array.forEach
12
+ *
13
+ * @param array - Array to iterate over
14
+ * @param options - Options for the function
15
+ * @param callbackfunction - Function to call for each item
16
+ */
17
+ export declare function forEachAsync<TItem>(array: Array<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: Array<TItem>) => Promisable<void>): Promise<void>;
18
+ export {};
@@ -0,0 +1,13 @@
1
+ import type { Parameters } from '../../types/Parameters';
2
+ import type { string_template } from '../../types/typeAliases';
3
+ /**
4
+ * Replaces parameters in template with values from parameters object
5
+ *
6
+ * @param template the template with parameters in {curly} braces
7
+ * @param parameters the object with parameters
8
+ * @returns the template with replaced parameters
9
+ * @throws {TemplateError} if parameter is not defined, not closed, or not opened
10
+ *
11
+ * @private within the createPromptbookExecutor
12
+ */
13
+ export declare function replaceParameters(template: string_template, parameters: Parameters): string;
@@ -0,0 +1,9 @@
1
+ import type { UncertainNumber } from '../PromptResult';
2
+ /**
3
+ * Make UncertainNumber
4
+ *
5
+ * @param value
6
+ *
7
+ * @private utility for initializating UncertainNumber
8
+ */
9
+ export declare function uncertainNumber(value?: number | typeof NaN | undefined | null): UncertainNumber;
@@ -0,0 +1,10 @@
1
+ import type { PromptResultUsage } from '../PromptResult';
2
+ import type { UncertainNumber } from '../PromptResult';
3
+ /**
4
+ * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
5
+ *
6
+ * Note: This is an estimate based of theese sources:
7
+ * - https://jecas.cz/doba-cteni
8
+ * - https://www.originalnitonery.cz/blog/psani-vsemi-deseti-se-muzete-naucit-i-sami-doma
9
+ */
10
+ export declare function usageToWorktime(usage: PromptResultUsage): UncertainNumber;
@@ -0,0 +1,25 @@
1
+ import type { Promisable } from 'type-fest';
2
+ import type { Prompt } from '../types/Prompt';
3
+ import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
4
+ import type { string_promptbook_url } from '../types/typeAliases';
5
+ /**
6
+ * Library of promptbooks that groups together promptbooks for an application.
7
+ *
8
+ * @see https://github.com/webgptorg/promptbook#promptbook-library
9
+ */
10
+ export type PromptbookLibrary = {
11
+ /**
12
+ * Gets all promptbooks in the library
13
+ */
14
+ listPromptbooks(): Promisable<Array<string_promptbook_url>>;
15
+ /**
16
+ * Gets promptbook by its URL
17
+ *
18
+ * Note: This is not a direct fetching from the URL, but a lookup in the library
19
+ */
20
+ getPromptbookByUrl(url: string_promptbook_url): Promisable<PromptbookJson>;
21
+ /**
22
+ * Checks whether given prompt was defined in any promptbook in the library
23
+ */
24
+ isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
25
+ };
@@ -0,0 +1,36 @@
1
+ import type { Prompt } from '../types/Prompt';
2
+ import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
3
+ import type { string_promptbook_url } from '../types/typeAliases';
4
+ import type { PromptbookLibrary } from './PromptbookLibrary';
5
+ /**
6
+ * Library of promptbooks that groups together promptbooks for an application.
7
+ * This implementation is a very thin wrapper around the Array / Map of promptbooks.
8
+ *
9
+ * @see https://github.com/webgptorg/promptbook#promptbook-library
10
+ */
11
+ export declare class SimplePromptbookLibrary implements PromptbookLibrary {
12
+ private library;
13
+ /**
14
+ * Constructs a promptbook library from promptbooks
15
+ *
16
+ * @param promptbooks !!!
17
+ *
18
+ * Note: During the construction logic of all promptbooks are validated
19
+ * Note: It is not recommended to use this constructor directly, use `createPromptbookLibraryFromSources` *(or other variant)* instead
20
+ */
21
+ constructor(...promptbooks: Array<PromptbookJson>);
22
+ /**
23
+ * Gets all promptbooks in the library
24
+ */
25
+ listPromptbooks(): Array<string_promptbook_url>;
26
+ /**
27
+ * Gets promptbook by its URL
28
+ *
29
+ * Note: This is not a direct fetching from the URL, but a lookup in the library
30
+ */
31
+ getPromptbookByUrl(url: string_promptbook_url): PromptbookJson;
32
+ /**
33
+ * Checks whether given prompt was defined in any promptbook in the library
34
+ */
35
+ isResponsibleForPrompt(prompt: Prompt): boolean;
36
+ }
@@ -0,0 +1,43 @@
1
+ import type { string_folder_path } from '../../types/typeAliases';
2
+ import type { PromptbookLibrary } from '../PromptbookLibrary';
3
+ /**
4
+ * Options for `createPromptbookLibraryFromDirectory` function
5
+ */
6
+ type CreatePromptbookLibraryFromDirectoryOptions = {
7
+ /**
8
+ * If true, the directory is searched recursively for promptbooks
9
+ *
10
+ * @default true
11
+ */
12
+ isRecursive?: boolean;
13
+ /**
14
+ * If true, the library creation outputs information about each file it reads
15
+ *
16
+ * @default false
17
+ */
18
+ isVerbose?: boolean;
19
+ /**
20
+ * If true, directory will be scanned only when needed not during the construction
21
+ *
22
+ * @default false
23
+ */
24
+ isLazyLoaded?: boolean;
25
+ /**
26
+ * If true, whole library creation crashes on error in any promptbook
27
+ * If true and isLazyLoaded is true, the error is thrown on first access to the promptbook
28
+ *
29
+ * @default true
30
+ */
31
+ isCrashOnError?: boolean;
32
+ };
33
+ /**
34
+ * Constructs Promptbook from given directory
35
+ *
36
+ * Note: Works only in Node.js environment because it reads the file system
37
+ *
38
+ * @param path - path to the directory with promptbooks
39
+ * @param options - Misc options for the library
40
+ * @returns PromptbookLibrary
41
+ */
42
+ export declare function createPromptbookLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): Promise<PromptbookLibrary>;
43
+ export {};
@@ -0,0 +1,23 @@
1
+ import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
2
+ import type { PromptbookString } from '../../types/PromptbookString';
3
+ import type { PromptbookLibrary } from '../PromptbookLibrary';
4
+ /**
5
+ * Constructs Promptbook from async sources
6
+ * It can be one of the following:
7
+ * - Promise of array of PromptbookJson or PromptbookString
8
+ * - Factory function that returns Promise of array of PromptbookJson or PromptbookString
9
+ *
10
+ * Note: This is useful as internal tool for other constructor functions like
11
+ * `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
12
+ * Consider using those functions instead of this one
13
+ *
14
+ * Note: The function does NOT return promise it returns the library directly which waits for the sources to be resolved
15
+ * when error occurs in given promise or factory function, it is thrown during `listPromptbooks` or `getPromptbookByUrl` call
16
+ *
17
+ * Note: Consider using `createPromptbookLibraryFromDirectory` or `createPromptbookLibraryFromUrl`
18
+ *
19
+ * @param promptbookSourcesPromiseOrFactory
20
+ * @returns PromptbookLibrary
21
+ * @private Just internal tool for other constructor functions
22
+ */
23
+ export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
@@ -0,0 +1,13 @@
1
+ import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
2
+ import type { PromptbookString } from '../../types/PromptbookString';
3
+ import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
4
+ /**
5
+ * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
6
+ *
7
+ * Note: You can combine `PromptbookString` (`.ptbk.md`) with `PromptbookJson` BUT it is not recommended
8
+ * Note: During the construction syntax and logic of all sources are validated
9
+ *
10
+ * @param promptbookSources
11
+ * @returns PromptbookLibrary
12
+ */
13
+ export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
@@ -0,0 +1,26 @@
1
+ import type { string_url } from '../../types/typeAliases';
2
+ import type { PromptbookLibrary } from '../PromptbookLibrary';
3
+ /**
4
+ * Options for `createPromptbookLibraryFromDirectory` function
5
+ */
6
+ type CreatePromptbookLibraryFromUrlyOptions = {
7
+ /**
8
+ * If true, the library creation outputs information about each file it reads
9
+ *
10
+ * @default false
11
+ */
12
+ isVerbose?: boolean;
13
+ /**
14
+ * If true, directory will be scanned only when needed not during the construction
15
+ *
16
+ * @default false
17
+ */
18
+ isLazyLoaded?: boolean;
19
+ };
20
+ /**
21
+ * Constructs Promptbook from remote Promptbase URL
22
+
23
+ * @returns PromptbookLibrary
24
+ */
25
+ export declare function createPromptbookLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
26
+ export {};
@@ -0,0 +1,12 @@
1
+ import type { string_promptbook_url } from '../../types/typeAliases';
2
+ import type { PromptbookLibrary } from '../PromptbookLibrary';
3
+ /**
4
+ * Creates PromptbookLibrary as a subset of another PromptbookLibrary
5
+ *
6
+ * Note: You can use any type of library as a parent library - local, remote, etc.
7
+ * Note: This is just a thin wrapper / proxy around the parent library
8
+ *
9
+ * @param promptbookSources
10
+ * @returns PromptbookLibrary
11
+ */
12
+ export declare function createPromptbookSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Just testing imports and compatibility
3
+ */
4
+ export declare function justTestFsImport(): Promise<void>;
5
+ /**
6
+ * TODO: !!! Remove this file
7
+ */
@@ -0,0 +1,101 @@
1
+ import type { string_markdown_text } from './typeAliases';
2
+ import type { string_name } from './typeAliases';
3
+ import type { string_version } from './typeAliases';
4
+ import type { ExecutionType } from './ExecutionTypes';
5
+ import type { ModelRequirements } from './ModelRequirements';
6
+ import type { ExpectationAmount } from './PromptbookJson/PromptTemplateJson';
7
+ import type { ExpectationUnit } from './PromptbookJson/PromptTemplateJson';
8
+ /**
9
+ * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
10
+ * It is parsed from the markdown from ul/ol items - one command per one item.
11
+ */
12
+ export type Command = PromptbookUrlCommand | PromptbookVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
13
+ /**
14
+ * PromptbookVersion command tells which version is .promptbook file using
15
+ *
16
+ * - It is used for backward compatibility
17
+ * - It is defined per whole .promptbook file in the header
18
+ */
19
+ export type PromptbookUrlCommand = {
20
+ readonly type: 'PROMPTBOOK_URL';
21
+ readonly promptbookUrl: URL;
22
+ };
23
+ /**
24
+ * PromptbookVersion command tells which version is .promptbook file using
25
+ *
26
+ * - It is used for backward compatibility
27
+ * - It is defined per whole .promptbook file in the header
28
+ */
29
+ export type PromptbookVersionCommand = {
30
+ readonly type: 'PROMPTBOOK_VERSION';
31
+ readonly promptbookVersion: string_version;
32
+ };
33
+ /**
34
+ * Execute command tells how to execute the section
35
+ * It can be either prompt template, script or SIMPLE TEMPLATE etc.
36
+ */
37
+ export type ExecuteCommand = {
38
+ readonly type: 'EXECUTE';
39
+ readonly executionType: ExecutionType;
40
+ };
41
+ /**
42
+ * Model command tells which model and modelRequirements to use for the prompt template. execution
43
+ */
44
+ export type ModelCommand = {
45
+ readonly type: 'MODEL';
46
+ readonly key: keyof ModelRequirements;
47
+ readonly value: any;
48
+ };
49
+ /**
50
+ * Joker parameter is used instead of executing the prompt template if it meet the expectations requirements
51
+ */
52
+ export type JokerCommand = {
53
+ readonly type: 'JOKER';
54
+ readonly parameterName: string_name;
55
+ };
56
+ /**
57
+ * Parameter command describes one parameter of the prompt template
58
+ *
59
+ * - It can tell if it is input or OUTPUT PARAMETER
60
+ * - It can have description
61
+ * - In description it can have simple formatting BUT not markdown structure or reference to other parameters
62
+ */
63
+ export type ParameterCommand = {
64
+ readonly type: 'PARAMETER';
65
+ readonly isInput: boolean;
66
+ readonly isOutput: boolean;
67
+ readonly parameterName: string_name;
68
+ readonly parameterDescription: string_markdown_text | null;
69
+ };
70
+ /**
71
+ * Postprocess command describes which function to use for postprocessing
72
+ * This will be created as separate EXECUTE SCRIPT block bellow
73
+ */
74
+ export type PostprocessCommand = {
75
+ readonly type: 'POSTPROCESS';
76
+ readonly functionName: string_name;
77
+ };
78
+ /**
79
+ * Expect command describes the desired output of the prompt template (after post-processing)
80
+ * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs or some other shape of the output.
81
+ */
82
+ export type ExpectCommand = ExpectAmountCommand | ExpectFormatCommand;
83
+ /**
84
+ * Expect amount command describes the desired output of the prompt template (after post-processing)
85
+ * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
86
+ *
87
+ * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
88
+ */
89
+ export type ExpectAmountCommand = {
90
+ readonly type: 'EXPECT_AMOUNT';
91
+ readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
92
+ readonly unit: ExpectationUnit;
93
+ readonly amount: ExpectationAmount;
94
+ };
95
+ /**
96
+ * Represents a command that expects a specific format.
97
+ */
98
+ export type ExpectFormatCommand = {
99
+ readonly type: 'EXPECT_FORMAT';
100
+ readonly format: 'JSON';
101
+ };