@promptbook/node 0.60.0 → 0.61.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 (350) hide show
  1. package/README.md +4 -6
  2. package/esm/index.es.js +2747 -1396
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/promptbook-collection/index.d.ts +61 -4
  5. package/esm/typings/src/_packages/core.index.d.ts +8 -8
  6. package/esm/typings/src/_packages/markdown-utils.d.ts +17 -0
  7. package/esm/typings/src/_packages/types.index.d.ts +11 -6
  8. package/esm/typings/src/_packages/utils.index.d.ts +23 -19
  9. package/esm/typings/src/cli/cli-commands/hello.d.ts +7 -0
  10. package/esm/typings/src/cli/cli-commands/make.d.ts +7 -0
  11. package/esm/typings/src/cli/cli-commands/prettify.d.ts +7 -0
  12. package/esm/typings/src/collection/collectionToJson.d.ts +3 -0
  13. package/esm/typings/src/collection/collectionToJson.test.d.ts +6 -0
  14. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +2 -1
  15. package/esm/typings/src/commands/BLOCK/BlockCommand.d.ts +11 -0
  16. package/esm/typings/src/commands/BLOCK/BlockTypes.d.ts +13 -0
  17. package/esm/typings/src/commands/BLOCK/blockCommandParser.d.ts +9 -0
  18. package/esm/typings/src/commands/EXPECT/ExpectAmountCommand.d.ts +14 -0
  19. package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts +9 -0
  20. package/esm/typings/src/commands/EXPECT/ExpectFormatCommand.d.ts +7 -0
  21. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +9 -0
  22. package/esm/typings/src/commands/JOKER/JokerCommand.d.ts +11 -0
  23. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +9 -0
  24. package/esm/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +12 -0
  25. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +9 -0
  26. package/esm/typings/src/commands/MODEL/ModelCommand.d.ts +13 -0
  27. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +9 -0
  28. package/esm/typings/src/commands/PARAMETER/ParameterCommand.d.ts +15 -0
  29. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +9 -0
  30. package/esm/typings/src/commands/PERSONA/PersonaCommand.d.ts +11 -0
  31. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +9 -0
  32. package/esm/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts +11 -0
  33. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +9 -0
  34. package/esm/typings/src/commands/PROMPTBOOK_VERSION/PromptbookVersionCommand.d.ts +11 -0
  35. package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +9 -0
  36. package/esm/typings/src/commands/URL/UrlCommand.d.ts +10 -0
  37. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +9 -0
  38. package/esm/typings/src/commands/X_ACTION/ActionCommand.d.ts +9 -0
  39. package/esm/typings/src/commands/X_ACTION/actionCommand.test.d.ts +1 -0
  40. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +9 -0
  41. package/esm/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +9 -0
  42. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts +1 -0
  43. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +9 -0
  44. package/esm/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +10 -0
  45. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts +1 -0
  46. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +12 -0
  47. package/esm/typings/src/commands/_common/parseCommand.d.ts +12 -0
  48. package/esm/typings/src/commands/_common/parseCommand.test.d.ts +1 -0
  49. package/esm/typings/src/commands/_common/types/Command.d.ts +6 -0
  50. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +36 -0
  51. package/esm/typings/src/commands/_common/types/CommandUsagePlaces.d.ts +9 -0
  52. package/esm/typings/src/commands/index.d.ts +4 -0
  53. package/esm/typings/src/config.d.ts +4 -0
  54. package/esm/typings/src/conversion/pipelineJsonToString.d.ts +2 -0
  55. package/esm/typings/src/conversion/pipelineStringToJson.d.ts +2 -3
  56. package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +4 -2
  57. package/esm/typings/src/conversion/utils/extractParametersFromPromptTemplate.d.ts +2 -2
  58. package/esm/typings/src/conversion/utils/extractVariables.d.ts +1 -1
  59. package/esm/typings/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +3 -0
  60. package/esm/typings/src/errors/NotYetImplementedError.d.ts +7 -0
  61. package/esm/typings/src/errors/{SyntaxError.d.ts → ParsingError.d.ts} +2 -2
  62. package/{umd/typings/src/errors/ExecutionError.d.ts → esm/typings/src/errors/PipelineExecutionError.d.ts} +2 -2
  63. package/esm/typings/src/errors/_ExpectError.d.ts +2 -2
  64. package/esm/typings/src/execution/ExecutionTools.d.ts +4 -3
  65. package/esm/typings/src/execution/LlmExecutionTools.d.ts +24 -5
  66. package/esm/typings/src/execution/PromptResult.d.ts +2 -2
  67. package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +1 -1
  68. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +1 -1
  69. package/esm/typings/src/execution/utils/checkExpectations.d.ts +1 -1
  70. package/esm/typings/src/execution/utils/replaceParameters.d.ts +1 -1
  71. package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +5 -0
  72. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +5 -5
  73. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -0
  74. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +5 -0
  75. package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +5 -0
  76. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +5 -0
  77. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +10 -0
  78. package/esm/typings/src/llm-providers/mocked/fakeTextToExpectations.d.ts +1 -1
  79. package/esm/typings/src/llm-providers/mocked/test/fakeTextToExpectations.test.d.ts +1 -0
  80. package/esm/typings/src/llm-providers/mocked/test/faked-completion.test.d.ts +1 -0
  81. package/esm/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts +5 -0
  82. package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +14 -1
  83. package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +16 -0
  84. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +6 -1
  85. package/esm/typings/src/llm-providers/openai/computeOpenaiUsage.d.ts +1 -1
  86. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -0
  87. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +13 -3
  88. package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts +1 -0
  89. package/esm/typings/src/personas/personaToModelRequirements.d.ts +6 -0
  90. package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +2 -1
  91. package/esm/typings/src/types/Arrayable.d.ts +10 -0
  92. package/esm/typings/src/types/PipelineJson/Expectations.d.ts +28 -0
  93. package/esm/typings/src/types/PipelineJson/LlmTemplateJson.d.ts +16 -0
  94. package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +8 -2
  95. package/esm/typings/src/types/PipelineJson/PromptDialogJson.d.ts +7 -0
  96. package/esm/typings/src/types/PipelineJson/PromptTemplateJson.d.ts +6 -142
  97. package/esm/typings/src/types/PipelineJson/PromptTemplateJsonCommon.d.ts +77 -0
  98. package/esm/typings/src/types/PipelineJson/ScriptJson.d.ts +14 -0
  99. package/esm/typings/src/types/PipelineJson/SimpleTemplateJson.d.ts +7 -0
  100. package/esm/typings/src/types/Prompt.d.ts +3 -3
  101. package/esm/typings/src/types/TaskProgress.d.ts +2 -2
  102. package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts +3 -3
  103. package/esm/typings/src/types/typeAliases.d.ts +50 -6
  104. package/esm/typings/src/utils/arrayableToArray.d.ts +11 -0
  105. package/esm/typings/src/utils/arrayableToArray.test.d.ts +1 -0
  106. package/esm/typings/src/utils/emojis.d.ts +1 -0
  107. package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts +1 -1
  108. package/esm/typings/src/utils/expectation-counters/countLines.d.ts +1 -1
  109. package/esm/typings/src/utils/expectation-counters/countPages.d.ts +1 -1
  110. package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts +1 -1
  111. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +1 -1
  112. package/esm/typings/src/utils/expectation-counters/countWords.d.ts +1 -1
  113. package/esm/typings/src/utils/expectation-counters/index.d.ts +2 -2
  114. package/esm/typings/src/utils/markdown/flattenMarkdown.d.ts +14 -0
  115. package/esm/typings/src/utils/markdown/flattenMarkdown.test.d.ts +1 -0
  116. package/esm/typings/src/utils/markdown/parseMarkdownSection.d.ts +30 -0
  117. package/esm/typings/src/utils/markdown/parseMarkdownSection.test.d.ts +1 -0
  118. package/esm/typings/src/utils/markdown/prettifyMarkdown.d.ts +1 -0
  119. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +12 -0
  120. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts +1 -0
  121. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts +8 -1
  122. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts +8 -1
  123. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +13 -1
  124. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.d.ts +8 -1
  125. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts +8 -1
  126. package/esm/typings/src/{conversion/utils → utils}/parseNumber.d.ts +1 -1
  127. package/esm/typings/src/utils/parseNumber.test.d.ts +1 -0
  128. package/esm/typings/src/utils/sets/difference.d.ts +2 -0
  129. package/esm/typings/src/utils/sets/intersection.d.ts +2 -0
  130. package/esm/typings/src/utils/sets/union.d.ts +2 -0
  131. package/esm/typings/src/utils/validators/email/isValidEmail.d.ts +5 -0
  132. package/esm/typings/src/utils/validators/email/isValidEmail.test.d.ts +1 -0
  133. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +7 -0
  134. package/esm/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts +1 -0
  135. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +2 -0
  136. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts +1 -0
  137. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +12 -0
  138. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts +1 -0
  139. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts +9 -0
  140. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts +1 -0
  141. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts +9 -0
  142. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts +1 -0
  143. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +12 -0
  144. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts +1 -0
  145. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.d.ts +12 -0
  146. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts +1 -0
  147. package/esm/typings/src/utils/validators/url/isValidUrl.d.ts +3 -0
  148. package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts +5 -0
  149. package/esm/typings/src/utils/validators/uuid/isValidUuid.test.d.ts +1 -0
  150. package/esm/typings/src/version.d.ts +3 -2
  151. package/package.json +2 -2
  152. package/umd/index.umd.js +2747 -1396
  153. package/umd/index.umd.js.map +1 -1
  154. package/umd/typings/promptbook-collection/index.d.ts +61 -4
  155. package/umd/typings/src/_packages/core.index.d.ts +8 -8
  156. package/umd/typings/src/_packages/markdown-utils.d.ts +17 -0
  157. package/umd/typings/src/_packages/types.index.d.ts +11 -6
  158. package/umd/typings/src/_packages/utils.index.d.ts +23 -19
  159. package/umd/typings/src/cli/cli-commands/hello.d.ts +7 -0
  160. package/umd/typings/src/cli/cli-commands/make.d.ts +7 -0
  161. package/umd/typings/src/cli/cli-commands/prettify.d.ts +7 -0
  162. package/umd/typings/src/collection/collectionToJson.d.ts +3 -0
  163. package/umd/typings/src/collection/collectionToJson.test.d.ts +6 -0
  164. package/umd/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +2 -1
  165. package/umd/typings/src/commands/BLOCK/BlockCommand.d.ts +11 -0
  166. package/umd/typings/src/commands/BLOCK/BlockTypes.d.ts +13 -0
  167. package/umd/typings/src/commands/BLOCK/blockCommand.test.d.ts +1 -0
  168. package/umd/typings/src/commands/BLOCK/blockCommandParser.d.ts +9 -0
  169. package/umd/typings/src/commands/EXPECT/ExpectAmountCommand.d.ts +14 -0
  170. package/umd/typings/src/commands/EXPECT/ExpectCommand.d.ts +9 -0
  171. package/umd/typings/src/commands/EXPECT/ExpectFormatCommand.d.ts +7 -0
  172. package/umd/typings/src/commands/EXPECT/expectCommand.test.d.ts +1 -0
  173. package/umd/typings/src/commands/EXPECT/expectCommandParser.d.ts +9 -0
  174. package/umd/typings/src/commands/JOKER/JokerCommand.d.ts +11 -0
  175. package/umd/typings/src/commands/JOKER/jokerCommand.test.d.ts +1 -0
  176. package/umd/typings/src/commands/JOKER/jokerCommandParser.d.ts +9 -0
  177. package/umd/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +12 -0
  178. package/umd/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts +1 -0
  179. package/umd/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +9 -0
  180. package/umd/typings/src/commands/MODEL/ModelCommand.d.ts +13 -0
  181. package/umd/typings/src/commands/MODEL/modelCommand.test.d.ts +1 -0
  182. package/umd/typings/src/commands/MODEL/modelCommandParser.d.ts +9 -0
  183. package/umd/typings/src/commands/PARAMETER/ParameterCommand.d.ts +15 -0
  184. package/umd/typings/src/commands/PARAMETER/parameterCommand.test.d.ts +1 -0
  185. package/umd/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +9 -0
  186. package/umd/typings/src/commands/PERSONA/PersonaCommand.d.ts +11 -0
  187. package/umd/typings/src/commands/PERSONA/personaCommand.test.d.ts +1 -0
  188. package/umd/typings/src/commands/PERSONA/personaCommandParser.d.ts +9 -0
  189. package/umd/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts +11 -0
  190. package/umd/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts +1 -0
  191. package/umd/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +9 -0
  192. package/umd/typings/src/commands/PROMPTBOOK_VERSION/PromptbookVersionCommand.d.ts +11 -0
  193. package/umd/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommand.test.d.ts +1 -0
  194. package/umd/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +9 -0
  195. package/umd/typings/src/commands/URL/UrlCommand.d.ts +10 -0
  196. package/umd/typings/src/commands/URL/urlCommand.test.d.ts +1 -0
  197. package/umd/typings/src/commands/URL/urlCommandParser.d.ts +9 -0
  198. package/umd/typings/src/commands/X_ACTION/ActionCommand.d.ts +9 -0
  199. package/umd/typings/src/commands/X_ACTION/actionCommand.test.d.ts +1 -0
  200. package/umd/typings/src/commands/X_ACTION/actionCommandParser.d.ts +9 -0
  201. package/umd/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +9 -0
  202. package/umd/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts +1 -0
  203. package/umd/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +9 -0
  204. package/umd/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +10 -0
  205. package/umd/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts +1 -0
  206. package/umd/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +12 -0
  207. package/umd/typings/src/commands/_common/parseCommand.d.ts +12 -0
  208. package/umd/typings/src/commands/_common/parseCommand.test.d.ts +1 -0
  209. package/umd/typings/src/commands/_common/types/Command.d.ts +6 -0
  210. package/umd/typings/src/commands/_common/types/CommandParser.d.ts +36 -0
  211. package/umd/typings/src/commands/_common/types/CommandUsagePlaces.d.ts +9 -0
  212. package/umd/typings/src/commands/index.d.ts +4 -0
  213. package/umd/typings/src/config.d.ts +4 -0
  214. package/umd/typings/src/conversion/pipelineJsonToString.d.ts +2 -0
  215. package/umd/typings/src/conversion/pipelineStringToJson.d.ts +2 -3
  216. package/umd/typings/src/conversion/pipelineStringToJsonSync.d.ts +4 -2
  217. package/umd/typings/src/conversion/utils/extractParametersFromPromptTemplate.d.ts +2 -2
  218. package/umd/typings/src/conversion/utils/extractVariables.d.ts +1 -1
  219. package/umd/typings/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +3 -0
  220. package/umd/typings/src/errors/NotYetImplementedError.d.ts +7 -0
  221. package/umd/typings/src/errors/{SyntaxError.d.ts → ParsingError.d.ts} +2 -2
  222. package/{esm/typings/src/errors/ExecutionError.d.ts → umd/typings/src/errors/PipelineExecutionError.d.ts} +2 -2
  223. package/umd/typings/src/errors/_ExpectError.d.ts +2 -2
  224. package/umd/typings/src/execution/ExecutionTools.d.ts +4 -3
  225. package/umd/typings/src/execution/LlmExecutionTools.d.ts +24 -5
  226. package/umd/typings/src/execution/PromptResult.d.ts +2 -2
  227. package/umd/typings/src/execution/assertsExecutionSuccessful.d.ts +1 -1
  228. package/umd/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +1 -1
  229. package/umd/typings/src/execution/utils/checkExpectations.d.ts +1 -1
  230. package/umd/typings/src/execution/utils/replaceParameters.d.ts +1 -1
  231. package/umd/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +5 -0
  232. package/umd/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +5 -5
  233. package/umd/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -0
  234. package/umd/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +5 -0
  235. package/umd/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +5 -0
  236. package/umd/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +5 -0
  237. package/umd/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +10 -0
  238. package/umd/typings/src/llm-providers/mocked/fakeTextToExpectations.d.ts +1 -1
  239. package/umd/typings/src/llm-providers/mocked/test/fakeTextToExpectations.test.d.ts +1 -0
  240. package/umd/typings/src/llm-providers/mocked/test/faked-completion.test.d.ts +1 -0
  241. package/umd/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts +5 -0
  242. package/umd/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +14 -1
  243. package/umd/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +16 -0
  244. package/umd/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +6 -1
  245. package/umd/typings/src/llm-providers/openai/computeOpenaiUsage.d.ts +1 -1
  246. package/umd/typings/src/llm-providers/openai/openai-models.d.ts +1 -0
  247. package/umd/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +13 -3
  248. package/umd/typings/src/llm-providers/remote/startRemoteServer.d.ts +1 -0
  249. package/umd/typings/src/personas/personaToModelRequirements.d.ts +6 -0
  250. package/umd/typings/src/scripting/javascript/utils/preserve.d.ts +2 -1
  251. package/umd/typings/src/types/Arrayable.d.ts +10 -0
  252. package/umd/typings/src/types/PipelineJson/Expectations.d.ts +28 -0
  253. package/umd/typings/src/types/PipelineJson/LlmTemplateJson.d.ts +16 -0
  254. package/umd/typings/src/types/PipelineJson/PipelineJson.d.ts +8 -2
  255. package/umd/typings/src/types/PipelineJson/PromptDialogJson.d.ts +7 -0
  256. package/umd/typings/src/types/PipelineJson/PromptTemplateJson.d.ts +6 -142
  257. package/umd/typings/src/types/PipelineJson/PromptTemplateJsonCommon.d.ts +77 -0
  258. package/umd/typings/src/types/PipelineJson/ScriptJson.d.ts +14 -0
  259. package/umd/typings/src/types/PipelineJson/SimpleTemplateJson.d.ts +7 -0
  260. package/umd/typings/src/types/Prompt.d.ts +3 -3
  261. package/umd/typings/src/types/TaskProgress.d.ts +2 -2
  262. package/umd/typings/src/types/execution-report/ExecutionReportJson.d.ts +3 -3
  263. package/umd/typings/src/types/typeAliases.d.ts +50 -6
  264. package/umd/typings/src/utils/arrayableToArray.d.ts +11 -0
  265. package/umd/typings/src/utils/arrayableToArray.test.d.ts +1 -0
  266. package/umd/typings/src/utils/emojis.d.ts +1 -0
  267. package/umd/typings/src/utils/expectation-counters/countCharacters.d.ts +1 -1
  268. package/umd/typings/src/utils/expectation-counters/countLines.d.ts +1 -1
  269. package/umd/typings/src/utils/expectation-counters/countPages.d.ts +1 -1
  270. package/umd/typings/src/utils/expectation-counters/countParagraphs.d.ts +1 -1
  271. package/umd/typings/src/utils/expectation-counters/countSentences.d.ts +1 -1
  272. package/umd/typings/src/utils/expectation-counters/countWords.d.ts +1 -1
  273. package/umd/typings/src/utils/expectation-counters/index.d.ts +2 -2
  274. package/umd/typings/src/utils/markdown/flattenMarkdown.d.ts +14 -0
  275. package/umd/typings/src/utils/markdown/flattenMarkdown.test.d.ts +1 -0
  276. package/umd/typings/src/utils/markdown/parseMarkdownSection.d.ts +30 -0
  277. package/umd/typings/src/utils/markdown/parseMarkdownSection.test.d.ts +1 -0
  278. package/umd/typings/src/utils/markdown/prettifyMarkdown.d.ts +1 -0
  279. package/umd/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +12 -0
  280. package/umd/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts +1 -0
  281. package/umd/typings/src/utils/normalization/normalize-to-kebab-case.d.ts +8 -1
  282. package/umd/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts +8 -1
  283. package/umd/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +13 -1
  284. package/umd/typings/src/utils/normalization/normalizeTo_camelCase.d.ts +8 -1
  285. package/umd/typings/src/utils/normalization/normalizeTo_snake_case.d.ts +8 -1
  286. package/umd/typings/src/{conversion/utils → utils}/parseNumber.d.ts +1 -1
  287. package/umd/typings/src/utils/parseNumber.test.d.ts +1 -0
  288. package/umd/typings/src/utils/sets/difference.d.ts +2 -0
  289. package/umd/typings/src/utils/sets/intersection.d.ts +2 -0
  290. package/umd/typings/src/utils/sets/union.d.ts +2 -0
  291. package/umd/typings/src/utils/validators/email/isValidEmail.d.ts +5 -0
  292. package/umd/typings/src/utils/validators/email/isValidEmail.test.d.ts +1 -0
  293. package/umd/typings/src/utils/validators/filePath/isValidFilePath.d.ts +7 -0
  294. package/umd/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts +1 -0
  295. package/umd/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +2 -0
  296. package/umd/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts +1 -0
  297. package/umd/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +12 -0
  298. package/umd/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts +1 -0
  299. package/umd/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts +9 -0
  300. package/umd/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts +1 -0
  301. package/umd/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts +9 -0
  302. package/umd/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts +1 -0
  303. package/umd/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +12 -0
  304. package/umd/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts +1 -0
  305. package/umd/typings/src/utils/validators/url/isValidPipelineUrl.d.ts +12 -0
  306. package/umd/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts +1 -0
  307. package/umd/typings/src/utils/validators/url/isValidUrl.d.ts +3 -0
  308. package/umd/typings/src/utils/validators/uuid/isValidUuid.d.ts +5 -0
  309. package/umd/typings/src/utils/validators/uuid/isValidUuid.test.d.ts +1 -0
  310. package/umd/typings/src/version.d.ts +3 -2
  311. package/esm/typings/src/cli/actions/hello.d.ts +0 -7
  312. package/esm/typings/src/cli/actions/make.d.ts +0 -7
  313. package/esm/typings/src/cli/actions/prettify.d.ts +0 -7
  314. package/esm/typings/src/conversion/utils/parseCommand.d.ts +0 -11
  315. package/esm/typings/src/conversion/utils/parseCommand.test.d.ts +0 -4
  316. package/esm/typings/src/errors/TemplateError.d.ts +0 -9
  317. package/esm/typings/src/llm-providers/mocked/mocked-chat.test.d.ts +0 -4
  318. package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionToolsOptions.d.ts +0 -24
  319. package/esm/typings/src/types/Command.d.ts +0 -101
  320. package/esm/typings/src/types/ExecutionTypes.d.ts +0 -13
  321. package/esm/typings/src/utils/markdown-json/MarkdownStructure.d.ts +0 -25
  322. package/esm/typings/src/utils/markdown-json/countMarkdownStructureDeepness.d.ts +0 -7
  323. package/esm/typings/src/utils/markdown-json/markdownToMarkdownStructure.d.ts +0 -13
  324. package/umd/typings/src/cli/actions/hello.d.ts +0 -7
  325. package/umd/typings/src/cli/actions/make.d.ts +0 -7
  326. package/umd/typings/src/cli/actions/prettify.d.ts +0 -7
  327. package/umd/typings/src/conversion/utils/parseCommand.d.ts +0 -11
  328. package/umd/typings/src/conversion/utils/parseCommand.test.d.ts +0 -4
  329. package/umd/typings/src/errors/TemplateError.d.ts +0 -9
  330. package/umd/typings/src/llm-providers/mocked/mocked-chat.test.d.ts +0 -4
  331. package/umd/typings/src/llm-providers/multiple/MultipleLlmExecutionToolsOptions.d.ts +0 -24
  332. package/umd/typings/src/types/Command.d.ts +0 -101
  333. package/umd/typings/src/types/ExecutionTypes.d.ts +0 -13
  334. package/umd/typings/src/utils/markdown-json/MarkdownStructure.d.ts +0 -25
  335. package/umd/typings/src/utils/markdown-json/countMarkdownStructureDeepness.d.ts +0 -7
  336. package/umd/typings/src/utils/markdown-json/markdownToMarkdownStructure.d.ts +0 -13
  337. /package/esm/typings/src/{conversion/utils/parseNumber.test.d.ts → commands/BLOCK/blockCommand.test.d.ts} +0 -0
  338. /package/esm/typings/src/{llm-providers/mocked/fakeTextToExpectations.test.d.ts → commands/EXPECT/expectCommand.test.d.ts} +0 -0
  339. /package/esm/typings/src/{llm-providers/mocked/faked-completion.test.d.ts → commands/JOKER/jokerCommand.test.d.ts} +0 -0
  340. /package/esm/typings/src/{utils/markdown-json/countMarkdownStructureDeepness.test.d.ts → commands/KNOWLEDGE/knowledgeCommand.test.d.ts} +0 -0
  341. /package/esm/typings/src/{utils/markdown-json/markdownToMarkdownStructure.test.d.ts → commands/MODEL/modelCommand.test.d.ts} +0 -0
  342. /package/{umd/typings/src/conversion/utils/parseNumber.test.d.ts → esm/typings/src/commands/PARAMETER/parameterCommand.test.d.ts} +0 -0
  343. /package/{umd/typings/src/llm-providers/mocked/fakeTextToExpectations.test.d.ts → esm/typings/src/commands/PERSONA/personaCommand.test.d.ts} +0 -0
  344. /package/{umd/typings/src/llm-providers/mocked/faked-completion.test.d.ts → esm/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts} +0 -0
  345. /package/{umd/typings/src/utils/markdown-json/countMarkdownStructureDeepness.test.d.ts → esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommand.test.d.ts} +0 -0
  346. /package/{umd/typings/src/utils/markdown-json/markdownToMarkdownStructure.test.d.ts → esm/typings/src/commands/URL/urlCommand.test.d.ts} +0 -0
  347. /package/esm/typings/src/llm-providers/mocked/{joker.test.d.ts → test/joker.test.d.ts} +0 -0
  348. /package/esm/typings/src/llm-providers/mocked/{mocked-completion.test.d.ts → test/mocked-completion.test.d.ts} +0 -0
  349. /package/umd/typings/src/llm-providers/mocked/{joker.test.d.ts → test/joker.test.d.ts} +0 -0
  350. /package/umd/typings/src/llm-providers/mocked/{mocked-completion.test.d.ts → test/mocked-completion.test.d.ts} +0 -0
@@ -1,4 +1,4 @@
1
- import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
1
+ import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
2
2
  /**
3
3
  * Counts number of characters in the text
4
4
  */
@@ -1,4 +1,4 @@
1
- import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
1
+ import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
2
2
  /**
3
3
  * Counts number of lines in the text
4
4
  */
@@ -1,4 +1,4 @@
1
- import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
1
+ import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
2
2
  /**
3
3
  * Counts number of pages in the text
4
4
  */
@@ -1,4 +1,4 @@
1
- import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
1
+ import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
2
2
  /**
3
3
  * Counts number of paragraphs in the text
4
4
  */
@@ -1,4 +1,4 @@
1
- import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
1
+ import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
2
2
  /**
3
3
  * Split text into sentences
4
4
  */
@@ -1,4 +1,4 @@
1
- import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
1
+ import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
2
2
  /**
3
3
  * Counts number of words in the text
4
4
  */
@@ -1,5 +1,5 @@
1
- import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
2
- import type { ExpectationUnit } from '../../types/PipelineJson/PromptTemplateJson';
1
+ import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
2
+ import type { ExpectationUnit } from '../../types/PipelineJson/Expectations';
3
3
  /**
4
4
  * Index of all counter functions
5
5
  */
@@ -0,0 +1,14 @@
1
+ import type { string_markdown } from '../../types/typeAliases';
2
+ /**
3
+ * Normalizes the markdown by flattening the structure
4
+ *
5
+ * - It always have h1 - if there is no h1 in the markdown, it will be added "# Untitled"
6
+ * - All other headings are normalized to h2
7
+ */
8
+ export declare function flattenMarkdown<TContent extends string_markdown>(markdown: TContent): TContent;
9
+ /**
10
+ * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more
11
+ * sophisticated implementation of this function through parsing markdown into JSON structure
12
+ * and flattening the actual structure
13
+ * NOW we are working just with markdown string and its good enough
14
+ */
@@ -0,0 +1,30 @@
1
+ import type { string_markdown_section } from '../../types/typeAliases';
2
+ import type { string_markdown_section_content } from '../../types/typeAliases';
3
+ import type { string_markdown_text } from '../../types/typeAliases';
4
+ /**
5
+ * Parsed markdown section
6
+ */
7
+ export type MarkdownSection = {
8
+ /**
9
+ * Title of the section
10
+ */
11
+ title: string_markdown_text;
12
+ /**
13
+ * Level of the section like h1, h2, h3, h4, h5, h6
14
+ */
15
+ level: 1 | 2 | 3 | 4 | 5 | 6;
16
+ /**
17
+ * Content of the section with markdown formatting, blocks, lists, etc.
18
+ */
19
+ content: string_markdown_section_content;
20
+ };
21
+ /**
22
+ * Parses markdown section to title its level and content
23
+ */
24
+ export declare function parseMarkdownSection(value: string_markdown_section): MarkdownSection;
25
+ /**
26
+ * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more
27
+ * sophisticated implementation of this function through parsing markdown into JSON structure
28
+ * and flattening the actual structure
29
+ * NOW we are working just with markdown string and its good enough
30
+ */
@@ -4,5 +4,6 @@ import type { string_html } from '../../types/typeAliases';
4
4
  *
5
5
  * @param content raw html code
6
6
  * @returns formatted html code
7
+ * @private withing the package because of HUGE size of prettier dependency
7
8
  */
8
9
  export declare function prettifyMarkdown<TContent extends string_html>(content: TContent): TContent;
@@ -0,0 +1,12 @@
1
+ import type { string_markdown } from '../../types/typeAliases';
2
+ import type { string_markdown_section } from '../../types/typeAliases';
3
+ /**
4
+ * Splits the markdown into sections by headings
5
+ */
6
+ export declare function splitMarkdownIntoSections(markdown: string_markdown): Array<string_markdown_section>;
7
+ /**
8
+ * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more
9
+ * sophisticated implementation of this function through parsing markdown into JSON structure
10
+ * and flattening the actual structure
11
+ * NOW we are working just with markdown string and its good enough
12
+ */
@@ -1 +1,8 @@
1
- export declare function normalizeToKebabCase(sentence: string): string;
1
+ /**
2
+ * Semantic helper for kebab-case strings
3
+ *
4
+ * @example 'hello-world'
5
+ * @example 'i-love-promptbook'
6
+ */
7
+ export type string_kebab_case = string;
8
+ export declare function normalizeToKebabCase(text: string): string_kebab_case;
@@ -1 +1,8 @@
1
- export declare function normalizeTo_PascalCase(sentence: string): string;
1
+ /**
2
+ * Semantic helper for PascalCase strings
3
+ *
4
+ * @example 'HelloWorld'
5
+ * @example 'ILovePromptbook'
6
+ */
7
+ export type string_PascalCase = string;
8
+ export declare function normalizeTo_PascalCase(text: string): string_PascalCase;
@@ -1,4 +1,16 @@
1
- export declare function normalizeTo_SCREAMING_CASE(sentence: string): string;
2
1
  /**
2
+ * Semantic helper for SCREAMING_CASE strings
3
+ *
4
+ * @example 'HELLO_WORLD'
5
+ * @example 'I_LOVE_PROMPTBOOK'
6
+ */
7
+ export type string_SCREAMING_CASE = string;
8
+ export declare function normalizeTo_SCREAMING_CASE(text: string): string_SCREAMING_CASE;
9
+ /**
10
+ * TODO: Tests
11
+ * > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'Moje tabule' })).toEqual('/VtG7sR9rRJqwNEdM2/Moje tabule');
12
+ * > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'ěščřžžýáíúů' })).toEqual('/VtG7sR9rRJqwNEdM2/escrzyaieuu');
13
+ * > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: ' ahoj ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj');
14
+ * > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: ' ahoj_ahojAhoj ahoj ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj-ahoj-ahoj-ahoj');
3
15
  * TODO: [🌺] Use some intermediate util splitWords
4
16
  */
@@ -1,4 +1,11 @@
1
- export declare function normalizeTo_camelCase(sentence: string, __firstLetterCapital?: boolean): string;
1
+ /**
2
+ * Semantic helper for camelCase strings
3
+ *
4
+ * @example 'helloWorld'
5
+ * @example 'iLovePromptbook'
6
+ */
7
+ export type string_camelCase = string;
8
+ export declare function normalizeTo_camelCase(text: string, _isFirstLetterCapital?: boolean): string_camelCase;
2
9
  /**
3
10
  * TODO: [🌺] Use some intermediate util splitWords
4
11
  */
@@ -1 +1,8 @@
1
- export declare function normalizeTo_snake_case(sentence: string): string;
1
+ /**
2
+ * Semantic helper for snake_case strings
3
+ *
4
+ * @example 'hello_world'
5
+ * @example 'i_love_promptbook'
6
+ */
7
+ export type string_snake_case = string;
8
+ export declare function normalizeTo_snake_case(text: string): string_snake_case;
@@ -5,7 +5,7 @@
5
5
  * Note: it also works only with decimal numbers
6
6
  *
7
7
  * @returns parsed number
8
- * @throws {SyntaxError} if the value is not a number
8
+ * @throws {ParsingError} if the value is not a number
9
9
  *
10
10
  * @private within the parseCommand
11
11
  */
@@ -0,0 +1 @@
1
+ export {};
@@ -1,4 +1,6 @@
1
1
  /**
2
2
  * Create difference set of two sets.
3
+ *
4
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
3
5
  */
4
6
  export declare function difference<TItem>(a: Set<TItem>, b: Set<TItem>, isEqual?: (a: TItem, b: TItem) => boolean): Set<TItem>;
@@ -1,4 +1,6 @@
1
1
  /**
2
2
  * Creates a new set with all elements that are present in all sets
3
+ *
4
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
3
5
  */
4
6
  export declare function intersection<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;
@@ -1,4 +1,6 @@
1
1
  /**
2
2
  * Creates a new set with all elements that are present in either set
3
+ *
4
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
3
5
  */
4
6
  export declare function union<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;
@@ -0,0 +1,5 @@
1
+ import type { string_email } from '../../../types/typeAliases';
2
+ /**
3
+ * Checks if value is valid email
4
+ */
5
+ export declare function isValidEmail(email: unknown): email is string_email;
@@ -0,0 +1,7 @@
1
+ import type { string_file_path } from '../../../types/typeAliases';
2
+ /**
3
+ * Tests if given string is valid URL.
4
+ *
5
+ * Note: This does not check if the file exists only if the path is valid
6
+ */
7
+ export declare function isValidFilePath(filePath: unknown): filePath is string_file_path;
@@ -0,0 +1,2 @@
1
+ import type { string_javascript_name } from '../../../types/typeAliases';
2
+ export declare function isValidJavascriptName(javascriptName: unknown): javascriptName is string_javascript_name;
@@ -0,0 +1,12 @@
1
+ import type { string_promptbook_version } from '../../../version';
2
+ /**
3
+ * Tests if given string is valid promptbook version
4
+ * It looks into list of known promptbook versions.
5
+ *
6
+ * @see https://www.npmjs.com/package/promptbook?activeTab=versions
7
+ * Note: When you are using for example promptbook 2.0.0 and there already is promptbook 3.0.0 it don`t know about it.
8
+ * Note: There are two simmilar functions:
9
+ * - `isValidSemanticVersion` which tests any semantic version
10
+ * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
11
+ */
12
+ export declare function isValidPromptbookVersion(version: unknown): version is string_promptbook_version;
@@ -0,0 +1,9 @@
1
+ import type { string_semantic_version } from '../../../types/typeAliases';
2
+ /**
3
+ * Tests if given string is valid semantic version
4
+ *
5
+ * Note: There are two simmilar functions:
6
+ * - `isValidSemanticVersion` which tests any semantic version
7
+ * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
8
+ */
9
+ export declare function isValidSemanticVersion(version: unknown): version is string_semantic_version;
@@ -0,0 +1,9 @@
1
+ import type { string_hostname } from '../../../types/typeAliases';
2
+ /**
3
+ * Checks if an URL is reserved for private networks or localhost.
4
+ *
5
+ * Note: There are two simmilar functions:
6
+ * - `isUrlOnPrivateNetwork` which tests full URL
7
+ * - `isHostnameOnPrivateNetwork` *(this one)* which tests just hostname
8
+ */
9
+ export declare function isHostnameOnPrivateNetwork(hostname: string_hostname): boolean;
@@ -0,0 +1,12 @@
1
+ import type { string_url } from '../../../types/typeAliases';
2
+ /**
3
+ * Checks if an IP address or hostname is reserved for private networks or localhost.
4
+ *
5
+ * Note: There are two simmilar functions:
6
+ * - `isUrlOnPrivateNetwork` *(this one)* which tests full URL
7
+ * - `isHostnameOnPrivateNetwork` which tests just hostname
8
+ *
9
+ * @param {string} ipAddress - The IP address to check.
10
+ * @returns {boolean} Returns true if the IP address is reserved for private networks or localhost, otherwise false.
11
+ */
12
+ export declare function isUrlOnPrivateNetwork(url: URL | string_url): boolean;
@@ -0,0 +1,12 @@
1
+ import type { string_pipeline_url } from '../../../types/typeAliases';
2
+ /**
3
+ * Tests if given string is valid pipeline URL URL.
4
+ *
5
+ * Note: There are two simmilar functions:
6
+ * - `isValidUrl` which tests any URL
7
+ * - `isValidPipelineUrl` *(this one)* which tests just pipeline URL
8
+ */
9
+ export declare function isValidPipelineUrl(url: unknown): url is string_pipeline_url;
10
+ /**
11
+ * TODO: [🐠] Maybe more info why the URL is invalid
12
+ */
@@ -3,5 +3,8 @@ import type { string_url } from '../../../types/typeAliases';
3
3
  * Tests if given string is valid URL.
4
4
  *
5
5
  * Note: Dataurl are considered perfectly valid.
6
+ * Note: There are two simmilar functions:
7
+ * - `isValidUrl` which tests any URL
8
+ * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
6
9
  */
7
10
  export declare function isValidUrl(url: unknown): url is string_url;
@@ -0,0 +1,5 @@
1
+ import type { string_uuid } from '../../../types/typeAliases';
2
+ /**
3
+ * Checks if value is valid uuid
4
+ */
5
+ export declare function isValidUuid(value: unknown): value is string_uuid;
@@ -1,5 +1,6 @@
1
- import type { string_version } from './types/typeAliases';
1
+ import type { string_semantic_version } from './types/typeAliases';
2
2
  /**
3
3
  * The version of the Promptbook library
4
4
  */
5
- export declare const PROMPTBOOK_VERSION: string_version;
5
+ export declare const PROMPTBOOK_VERSION: string_promptbook_version;
6
+ export type string_promptbook_version = string_semantic_version;
@@ -1,7 +0,0 @@
1
- import type { Command } from 'commander';
2
- /**
3
- * Initializes testing `hello` command for Promptbook CLI utilities
4
- *
5
- * @private part of `promptbookCli`
6
- */
7
- export declare function initializeHello(program: Command): void;
@@ -1,7 +0,0 @@
1
- import type { Command } from 'commander';
2
- /**
3
- * Initializes `make` command for Promptbook CLI utilities
4
- *
5
- * @private part of `promptbookCli`
6
- */
7
- export declare function initializeMake(program: Command): void;
@@ -1,7 +0,0 @@
1
- import type { Command } from 'commander';
2
- /**
3
- * Initializes `prettify` command for Promptbook CLI utilities
4
- *
5
- * @private part of `promptbookCli`
6
- */
7
- export declare function initializePrettify(program: Command): void;
@@ -1,11 +0,0 @@
1
- import type { Command } from '../../types/Command';
2
- import type { string_markdown_text } from '../../types/typeAliases';
3
- /**
4
- * Parses one line of ul/ol to command
5
- *
6
- * @returns parsed command object
7
- * @throws {SyntaxError} if the command is invalid
8
- *
9
- * @private within the pipelineStringToJson
10
- */
11
- export declare function parseCommand(listItem: string_markdown_text): Command;
@@ -1,4 +0,0 @@
1
- export {};
2
- /**
3
- * TODO: [🧠] Probbably change syntax MODEL VARIANT -> MODEL
4
- */
@@ -1,9 +0,0 @@
1
- /**
2
- * This error occurs during the parameter replacement in the template
3
- *
4
- * Note: This is a kindof subtype of ExecutionError because it occurs during the execution of the pipeline
5
- */
6
- export declare class TemplateError extends Error {
7
- readonly name = "TemplateError";
8
- constructor(message: string);
9
- }
@@ -1,4 +0,0 @@
1
- export {};
2
- /**
3
- * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPipelineExecutor.test.ts"
4
- */
@@ -1,24 +0,0 @@
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 MultipleLlmExecutionTools
6
- */
7
- export type MultipleLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
8
- /**
9
- * URL of the multiple PROMPTBOOK server
10
- * On this server will be connected to the socket.io server
11
- */
12
- readonly multipleUrl: 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,101 +0,0 @@
1
- import type { ExecutionType } from './ExecutionTypes';
2
- import type { ModelRequirements } from './ModelRequirements';
3
- import type { ExpectationAmount } from './PipelineJson/PromptTemplateJson';
4
- import type { ExpectationUnit } from './PipelineJson/PromptTemplateJson';
5
- import type { string_markdown_text } from './typeAliases';
6
- import type { string_name } from './typeAliases';
7
- import type { string_version } from './typeAliases';
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: 'PIPELINE_URL';
21
- readonly pipelineUrl: 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
- };
@@ -1,13 +0,0 @@
1
- import type { TupleToUnion } from 'type-fest';
2
- /**
3
- * Execution type describes the way how the block is executed
4
- *
5
- * @see https://github.com/webgptorg/promptbook#execution-type
6
- */
7
- export type ExecutionType = TupleToUnion<typeof ExecutionTypes>;
8
- /**
9
- * Execution type describes the way how the block is executed
10
- *
11
- * @see https://github.com/webgptorg/promptbook#execution-type
12
- */
13
- export declare const ExecutionTypes: readonly ["PROMPT_TEMPLATE", "SIMPLE_TEMPLATE", "SCRIPT", "PROMPT_DIALOG"];
@@ -1,25 +0,0 @@
1
- /**
2
- * Represents the structure of a markdown file.
3
- *
4
- * @private within the package
5
- */
6
- export type MarkdownStructure = {
7
- /**
8
- * The section level of the markdown file.
9
- * h1 is level 1, h2 is level 2, etc.
10
- */
11
- level: number;
12
- /**
13
- * The title of the markdown file.
14
- */
15
- title: string;
16
- /**
17
- * Content of the section.
18
- * It contains text, images, formatting, ul, ol, hr, blockquotes, etc. BUT not headings and sub-sections
19
- */
20
- content: string;
21
- /**
22
- * The sub-sections of current section which are recursively structured.
23
- */
24
- sections: MarkdownStructure[];
25
- };
@@ -1,7 +0,0 @@
1
- import type { MarkdownStructure } from './MarkdownStructure';
2
- /**
3
- * Computes the deepness of the markdown structure.
4
- *
5
- * @private within the package
6
- */
7
- export declare function countMarkdownStructureDeepness(markdownStructure: MarkdownStructure): number;
@@ -1,13 +0,0 @@
1
- import type { MarkdownStructure } from './MarkdownStructure';
2
- /**
3
- * Parse a markdown string into a MarkdownStructure object.
4
- *
5
- * Note: This function does work with code blocks
6
- * Note: This function does not work with markdown comments
7
- *
8
- * @param markdown The markdown string to parse.
9
- * @returns The MarkdownStructure object.
10
- *
11
- * @private within the package
12
- */
13
- export declare function markdownToMarkdownStructure(markdown: string): MarkdownStructure;