@promptbook/utils 0.52.0-9 → 0.53.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 (168) hide show
  1. package/README.md +1 -13
  2. package/esm/index.es.js +807 -697
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/_packages/core.index.d.ts +4 -2
  5. package/esm/typings/_packages/utils.index.d.ts +2 -0
  6. package/esm/typings/conversion/prettify/prettifyPromptbookString.d.ts +1 -1
  7. package/esm/typings/conversion/prettify/renderPromptbookMermaid.d.ts +2 -1
  8. package/esm/typings/conversion/utils/extractParametersFromPromptTemplate.d.ts +3 -3
  9. package/esm/typings/conversion/utils/extractVariables.d.ts +2 -1
  10. package/esm/typings/conversion/validation/_importPromptbook.d.ts +2 -2
  11. package/esm/typings/errors/PromptbookLibraryError.d.ts +7 -0
  12. package/esm/typings/execution/ExecutionTools.d.ts +5 -3
  13. package/esm/typings/execution/LlmExecutionTools.d.ts +4 -2
  14. package/esm/typings/execution/PromptResult.d.ts +5 -1
  15. package/esm/typings/execution/ScriptExecutionTools.d.ts +2 -1
  16. package/esm/typings/execution/UserInterfaceTools.d.ts +2 -1
  17. package/esm/typings/execution/createPromptbookExecutor.d.ts +3 -3
  18. package/esm/typings/execution/plugins/llm-execution-tools/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +4 -3
  19. package/esm/typings/execution/plugins/llm-execution-tools/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  20. package/esm/typings/execution/plugins/llm-execution-tools/azure-openai/AzureOpenAiExecutionTools.d.ts +4 -3
  21. package/esm/typings/execution/plugins/llm-execution-tools/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +2 -1
  22. package/esm/typings/execution/plugins/llm-execution-tools/langtail/LangtailExecutionTools.d.ts +0 -3
  23. package/esm/typings/execution/plugins/llm-execution-tools/mocked/MockedEchoLlmExecutionTools.d.ts +4 -2
  24. package/esm/typings/execution/plugins/llm-execution-tools/mocked/MockedFackedLlmExecutionTools.d.ts +4 -2
  25. package/esm/typings/execution/plugins/llm-execution-tools/mocked/fakeTextToExpectations.d.ts +1 -1
  26. package/esm/typings/execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools.d.ts +4 -2
  27. package/esm/typings/execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionToolsOptions.d.ts +2 -1
  28. package/esm/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools.d.ts +5 -3
  29. package/esm/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionToolsOptions.d.ts +1 -1
  30. package/esm/typings/execution/plugins/llm-execution-tools/openai/openai-models.d.ts +1 -1
  31. package/esm/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts +5 -3
  32. package/esm/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionToolsOptions.d.ts +2 -1
  33. package/esm/typings/execution/plugins/llm-execution-tools/remote/interfaces/Promptbook_Server_Progress.d.ts +1 -1
  34. package/esm/typings/execution/plugins/llm-execution-tools/remote/interfaces/Promptbook_Server_Response.d.ts +1 -1
  35. package/esm/typings/execution/plugins/llm-execution-tools/remote/interfaces/RemoteServerOptions.d.ts +2 -1
  36. package/esm/typings/execution/plugins/llm-execution-tools/remote/startRemoteServer.d.ts +2 -1
  37. package/esm/typings/execution/plugins/script-execution-tools/python/PythonExecutionTools.d.ts +3 -2
  38. package/esm/typings/execution/plugins/script-execution-tools/typescript/TypescriptExecutionTools.d.ts +3 -2
  39. package/esm/typings/execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools.d.ts +3 -2
  40. package/esm/typings/execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools.d.ts +3 -2
  41. package/esm/typings/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +1 -1
  42. package/esm/typings/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +1 -1
  43. package/esm/typings/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +2 -2
  44. package/esm/typings/execution/translation/automatic-translate/translateMessages.d.ts +2 -2
  45. package/esm/typings/execution/utils/forEachAsync.d.ts +18 -0
  46. package/esm/typings/execution/utils/replaceParameters.d.ts +2 -2
  47. package/esm/typings/library/SimplePromptbookLibrary.d.ts +1 -1
  48. package/esm/typings/library/constructors/createPromptbookLibraryFromDirectory.d.ts +30 -6
  49. package/esm/typings/library/constructors/createPromptbookLibraryFromDirectory.test.d.ts +1 -0
  50. package/esm/typings/library/constructors/createPromptbookLibraryFromPromise.d.ts +4 -4
  51. package/esm/typings/library/constructors/createPromptbookLibraryFromPromise.test.d.ts +1 -0
  52. package/esm/typings/library/constructors/createPromptbookLibraryFromSources.d.ts +2 -1
  53. package/esm/typings/library/constructors/createPromptbookLibraryFromSources.test.d.ts +1 -0
  54. package/esm/typings/library/constructors/createPromptbookLibraryFromUrl.d.ts +23 -6
  55. package/esm/typings/library/constructors/createPromptbookSublibrary.d.ts +1 -1
  56. package/esm/typings/library/constructors/justTestFsImport.d.ts +7 -0
  57. package/esm/typings/types/Command.d.ts +5 -2
  58. package/esm/typings/types/Prompt.d.ts +5 -2
  59. package/esm/typings/types/PromptbookJson/PromptTemplateJson.d.ts +8 -1
  60. package/esm/typings/types/PromptbookJson/PromptbookJson.d.ts +2 -1
  61. package/esm/typings/types/TaskProgress.d.ts +2 -1
  62. package/esm/typings/types/execution-report/ExecutionReportJson.d.ts +2 -1
  63. package/esm/typings/types/execution-report/countWorkingDuration.d.ts +1 -1
  64. package/esm/typings/types/typeAliases.d.ts +2 -2
  65. package/esm/typings/utils/emojis.d.ts +1 -1
  66. package/esm/typings/utils/expectation-counters/index.d.ts +2 -1
  67. package/esm/typings/utils/extractParameters.d.ts +2 -1
  68. package/esm/typings/utils/markdown/addAutoGeneratedSection.d.ts +2 -1
  69. package/esm/typings/utils/markdown/createMarkdownChart.d.ts +2 -2
  70. package/esm/typings/utils/markdown/createMarkdownTable.d.ts +2 -1
  71. package/esm/typings/utils/markdown/escapeMarkdownBlock.d.ts +1 -1
  72. package/esm/typings/utils/markdown/extractAllListItemsFromMarkdown.d.ts +2 -1
  73. package/esm/typings/utils/markdown/extractOneBlockFromMarkdown.d.ts +2 -2
  74. package/esm/typings/utils/markdown/removeContentComments.d.ts +2 -1
  75. package/esm/typings/utils/markdown/removeMarkdownFormatting.d.ts +1 -1
  76. package/esm/typings/utils/markdown-json/countMarkdownStructureDeepness.d.ts +1 -1
  77. package/esm/typings/utils/markdown-json/markdownToMarkdownStructure.d.ts +1 -1
  78. package/esm/typings/utils/normalization/isValidKeyword.d.ts +1 -1
  79. package/esm/typings/utils/normalization/parseKeywords.d.ts +1 -1
  80. package/esm/typings/utils/normalization/parseKeywordsFromString.d.ts +1 -1
  81. package/esm/typings/utils/normalization/searchKeywords.d.ts +1 -1
  82. package/esm/typings/utils/postprocessing/extractBlock.d.ts +1 -1
  83. package/package.json +2 -2
  84. package/umd/index.umd.js +807 -696
  85. package/umd/index.umd.js.map +1 -1
  86. package/umd/typings/_packages/core.index.d.ts +4 -2
  87. package/umd/typings/_packages/utils.index.d.ts +2 -0
  88. package/umd/typings/conversion/prettify/prettifyPromptbookString.d.ts +1 -1
  89. package/umd/typings/conversion/prettify/renderPromptbookMermaid.d.ts +2 -1
  90. package/umd/typings/conversion/utils/extractParametersFromPromptTemplate.d.ts +3 -3
  91. package/umd/typings/conversion/utils/extractVariables.d.ts +2 -1
  92. package/umd/typings/conversion/validation/_importPromptbook.d.ts +2 -2
  93. package/umd/typings/errors/PromptbookLibraryError.d.ts +7 -0
  94. package/umd/typings/execution/ExecutionTools.d.ts +5 -3
  95. package/umd/typings/execution/LlmExecutionTools.d.ts +4 -2
  96. package/umd/typings/execution/PromptResult.d.ts +5 -1
  97. package/umd/typings/execution/ScriptExecutionTools.d.ts +2 -1
  98. package/umd/typings/execution/UserInterfaceTools.d.ts +2 -1
  99. package/umd/typings/execution/createPromptbookExecutor.d.ts +3 -3
  100. package/umd/typings/execution/plugins/llm-execution-tools/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +4 -3
  101. package/umd/typings/execution/plugins/llm-execution-tools/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  102. package/umd/typings/execution/plugins/llm-execution-tools/azure-openai/AzureOpenAiExecutionTools.d.ts +4 -3
  103. package/umd/typings/execution/plugins/llm-execution-tools/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +2 -1
  104. package/umd/typings/execution/plugins/llm-execution-tools/langtail/LangtailExecutionTools.d.ts +0 -3
  105. package/umd/typings/execution/plugins/llm-execution-tools/mocked/MockedEchoLlmExecutionTools.d.ts +4 -2
  106. package/umd/typings/execution/plugins/llm-execution-tools/mocked/MockedFackedLlmExecutionTools.d.ts +4 -2
  107. package/umd/typings/execution/plugins/llm-execution-tools/mocked/fakeTextToExpectations.d.ts +1 -1
  108. package/umd/typings/execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools.d.ts +4 -2
  109. package/umd/typings/execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionToolsOptions.d.ts +2 -1
  110. package/umd/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools.d.ts +5 -3
  111. package/umd/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionToolsOptions.d.ts +1 -1
  112. package/umd/typings/execution/plugins/llm-execution-tools/openai/openai-models.d.ts +1 -1
  113. package/umd/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts +5 -3
  114. package/umd/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionToolsOptions.d.ts +2 -1
  115. package/umd/typings/execution/plugins/llm-execution-tools/remote/interfaces/Promptbook_Server_Progress.d.ts +1 -1
  116. package/umd/typings/execution/plugins/llm-execution-tools/remote/interfaces/Promptbook_Server_Response.d.ts +1 -1
  117. package/umd/typings/execution/plugins/llm-execution-tools/remote/interfaces/RemoteServerOptions.d.ts +2 -1
  118. package/umd/typings/execution/plugins/llm-execution-tools/remote/startRemoteServer.d.ts +2 -1
  119. package/umd/typings/execution/plugins/script-execution-tools/python/PythonExecutionTools.d.ts +3 -2
  120. package/umd/typings/execution/plugins/script-execution-tools/typescript/TypescriptExecutionTools.d.ts +3 -2
  121. package/umd/typings/execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools.d.ts +3 -2
  122. package/umd/typings/execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools.d.ts +3 -2
  123. package/umd/typings/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +1 -1
  124. package/umd/typings/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +1 -1
  125. package/umd/typings/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +2 -2
  126. package/umd/typings/execution/translation/automatic-translate/translateMessages.d.ts +2 -2
  127. package/umd/typings/execution/utils/forEachAsync.d.ts +18 -0
  128. package/umd/typings/execution/utils/replaceParameters.d.ts +2 -2
  129. package/umd/typings/library/SimplePromptbookLibrary.d.ts +1 -1
  130. package/umd/typings/library/constructors/createPromptbookLibraryFromDirectory.d.ts +30 -6
  131. package/umd/typings/library/constructors/createPromptbookLibraryFromDirectory.test.d.ts +1 -0
  132. package/umd/typings/library/constructors/createPromptbookLibraryFromPromise.d.ts +4 -4
  133. package/umd/typings/library/constructors/createPromptbookLibraryFromPromise.test.d.ts +1 -0
  134. package/umd/typings/library/constructors/createPromptbookLibraryFromSources.d.ts +2 -1
  135. package/umd/typings/library/constructors/createPromptbookLibraryFromSources.test.d.ts +1 -0
  136. package/umd/typings/library/constructors/createPromptbookLibraryFromUrl.d.ts +23 -6
  137. package/umd/typings/library/constructors/createPromptbookSublibrary.d.ts +1 -1
  138. package/umd/typings/library/constructors/justTestFsImport.d.ts +7 -0
  139. package/umd/typings/types/Command.d.ts +5 -2
  140. package/umd/typings/types/Prompt.d.ts +5 -2
  141. package/umd/typings/types/PromptbookJson/PromptTemplateJson.d.ts +8 -1
  142. package/umd/typings/types/PromptbookJson/PromptbookJson.d.ts +2 -1
  143. package/umd/typings/types/TaskProgress.d.ts +2 -1
  144. package/umd/typings/types/execution-report/ExecutionReportJson.d.ts +2 -1
  145. package/umd/typings/types/execution-report/countWorkingDuration.d.ts +1 -1
  146. package/umd/typings/types/typeAliases.d.ts +2 -2
  147. package/umd/typings/utils/emojis.d.ts +1 -1
  148. package/umd/typings/utils/expectation-counters/index.d.ts +2 -1
  149. package/umd/typings/utils/extractParameters.d.ts +2 -1
  150. package/umd/typings/utils/markdown/addAutoGeneratedSection.d.ts +2 -1
  151. package/umd/typings/utils/markdown/createMarkdownChart.d.ts +2 -2
  152. package/umd/typings/utils/markdown/createMarkdownTable.d.ts +2 -1
  153. package/umd/typings/utils/markdown/escapeMarkdownBlock.d.ts +1 -1
  154. package/umd/typings/utils/markdown/extractAllListItemsFromMarkdown.d.ts +2 -1
  155. package/umd/typings/utils/markdown/extractOneBlockFromMarkdown.d.ts +2 -2
  156. package/umd/typings/utils/markdown/removeContentComments.d.ts +2 -1
  157. package/umd/typings/utils/markdown/removeMarkdownFormatting.d.ts +1 -1
  158. package/umd/typings/utils/markdown-json/countMarkdownStructureDeepness.d.ts +1 -1
  159. package/umd/typings/utils/markdown-json/markdownToMarkdownStructure.d.ts +1 -1
  160. package/umd/typings/utils/normalization/isValidKeyword.d.ts +1 -1
  161. package/umd/typings/utils/normalization/parseKeywords.d.ts +1 -1
  162. package/umd/typings/utils/normalization/parseKeywordsFromString.d.ts +1 -1
  163. package/umd/typings/utils/normalization/searchKeywords.d.ts +1 -1
  164. package/umd/typings/utils/postprocessing/extractBlock.d.ts +1 -1
  165. package/esm/typings/wizzard/Wizzard.d.ts +0 -4
  166. package/esm/typings/wizzard/sample.d.ts +0 -6
  167. package/umd/typings/wizzard/Wizzard.d.ts +0 -4
  168. package/umd/typings/wizzard/sample.d.ts +0 -6
package/README.md CHANGED
@@ -11,7 +11,6 @@ Library to supercharge your use of large language models
11
11
  [![Issues](https://img.shields.io/github/issues/webgptorg/promptbook.svg?style=flat)](https://github.com/webgptorg/promptbook/issues)
12
12
 
13
13
 
14
- [![Socket Badge](https://socket.dev/api/badge/npm/package/@promptbook/utils)](https://socket.dev/npm/package/@promptbook/utils)
15
14
 
16
15
 
17
16
 
@@ -192,15 +191,6 @@ In any of these situations, but especially in (3), the Promptbook library can ma
192
191
  - _(Not ready yet)_ Leverage the **streaming** to make super cool UI/UX.
193
192
  - _(Not ready yet)_ **A/B testing** to determine which prompt works best for the job.
194
193
 
195
- ![WebGPT](./other/screencasts/screencast-fiabciakcmgepblmdkmemdbbkilneeeh-2023.10.26-21_46_17.gif)
196
-
197
- ## 🧔 Promptbook _(for prompt-engeneers)_
198
-
199
- **P**romp**t** **b**oo**k** markdown file (**PTBK** for short, or `.ptbk.md`) is document that describes a series of prompts that are chained together to form somewhat reciepe for transforming natural language input. Inside a PTBK you can use chat prompts, completion prompts, scripting or trigger interaction with user to ask for additional information.
200
-
201
- - Multiple promptbooks forms a library which will become a **part of your application codebase**.
202
- - Theese promptbooks are designed such as they **can be written by non-programmers**.
203
-
204
194
 
205
195
 
206
196
  ### Sample:
@@ -213,7 +203,7 @@ File `write-website-content.ptbk.md`:
213
203
  >
214
204
  > Instructions for creating web page content.
215
205
  >
216
- > - PROMPTBOOK URL https://promptbook.webgpt.com/en/write-website-content.ptbk.md@v0.1.0
206
+ > - PROMPTBOOK URL https://promptbook.webgpt.com/en/write-website-content.ptbk.md
217
207
  > - PROMPTBOOK VERSION 0.0.1
218
208
  > - INPUT  PARAM `{rawTitle}` Automatically suggested a site name or empty text
219
209
  > - INPUT  PARAM `{rawAssigment}` Automatically generated site entry from image recognition
@@ -672,8 +662,6 @@ _Note: LLMs work with tokens, not characters, but in Promptbooks we want to use
672
662
  ```markdown
673
663
  # ✨ Sample: Expectations
674
664
 
675
- - PROMPTBOOK URL https://promptbook.example.com/samples/postprocessing-2.ptbk.md@v1
676
- - PROMPTBOOK VERSION 1.0.0
677
665
  - INPUT  PARAMETER {yourName} Name of the hero
678
666
 
679
667
  ## 💬 Question