@promptbook/editable 0.81.0-5

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 (638) hide show
  1. package/README.md +421 -0
  2. package/esm/index.es.js +629 -0
  3. package/esm/index.es.js.map +1 -0
  4. package/esm/typings/books/index.d.ts +78 -0
  5. package/esm/typings/src/_packages/anthropic-claude.index.d.ts +16 -0
  6. package/esm/typings/src/_packages/azure-openai.index.d.ts +10 -0
  7. package/esm/typings/src/_packages/browser.index.d.ts +10 -0
  8. package/esm/typings/src/_packages/cli.index.d.ts +44 -0
  9. package/esm/typings/src/_packages/core.index.d.ts +236 -0
  10. package/esm/typings/src/_packages/documents.index.d.ts +8 -0
  11. package/esm/typings/src/_packages/editable.index.d.ts +10 -0
  12. package/esm/typings/src/_packages/execute-javascript.index.d.ts +8 -0
  13. package/esm/typings/src/_packages/fake-llm.index.d.ts +6 -0
  14. package/esm/typings/src/_packages/google.index.d.ts +10 -0
  15. package/esm/typings/src/_packages/legacy-documents.index.d.ts +8 -0
  16. package/esm/typings/src/_packages/markdown-utils.index.d.ts +48 -0
  17. package/esm/typings/src/_packages/node.index.d.ts +22 -0
  18. package/esm/typings/src/_packages/openai.index.d.ts +20 -0
  19. package/esm/typings/src/_packages/pdf.index.d.ts +8 -0
  20. package/esm/typings/src/_packages/remote-client.index.d.ts +8 -0
  21. package/esm/typings/src/_packages/remote-server.index.d.ts +6 -0
  22. package/esm/typings/src/_packages/templates.index.d.ts +4 -0
  23. package/esm/typings/src/_packages/types.index.d.ts +528 -0
  24. package/esm/typings/src/_packages/utils.index.d.ts +150 -0
  25. package/esm/typings/src/_packages/vercel.index.d.ts +6 -0
  26. package/esm/typings/src/_packages/website-crawler.index.d.ts +8 -0
  27. package/esm/typings/src/cli/cli-commands/about.d.ts +12 -0
  28. package/esm/typings/src/cli/cli-commands/hello.d.ts +12 -0
  29. package/esm/typings/src/cli/cli-commands/list-models.d.ts +11 -0
  30. package/esm/typings/src/cli/cli-commands/make.d.ts +14 -0
  31. package/esm/typings/src/cli/cli-commands/prettify.d.ts +13 -0
  32. package/esm/typings/src/cli/cli-commands/run.d.ts +15 -0
  33. package/esm/typings/src/cli/cli-commands/runInteractiveChatbot.d.ts +32 -0
  34. package/esm/typings/src/cli/cli-commands/test-command.d.ts +14 -0
  35. package/esm/typings/src/cli/main.d.ts +16 -0
  36. package/esm/typings/src/cli/promptbookCli.d.ts +13 -0
  37. package/esm/typings/src/cli/test/ptbk.d.ts +5 -0
  38. package/esm/typings/src/cli/test/ptbk.test.d.ts +1 -0
  39. package/esm/typings/src/collection/PipelineCollection.d.ts +25 -0
  40. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +37 -0
  41. package/esm/typings/src/collection/collectionToJson.d.ts +13 -0
  42. package/esm/typings/src/collection/collectionToJson.test.d.ts +7 -0
  43. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +54 -0
  44. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.test.d.ts +1 -0
  45. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +13 -0
  46. package/esm/typings/src/collection/constructors/createCollectionFromJson.test.d.ts +1 -0
  47. package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +23 -0
  48. package/esm/typings/src/collection/constructors/createCollectionFromPromise.test.d.ts +1 -0
  49. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +29 -0
  50. package/esm/typings/src/collection/constructors/createSubcollection.d.ts +13 -0
  51. package/esm/typings/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +11 -0
  52. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommand.test.d.ts +1 -0
  53. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts +9 -0
  54. package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts +17 -0
  55. package/esm/typings/src/commands/EXPECT/expectCommand.test.d.ts +1 -0
  56. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +9 -0
  57. package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts +10 -0
  58. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +27 -0
  59. package/esm/typings/src/commands/FOREACH/foreachCommand.test.d.ts +1 -0
  60. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +14 -0
  61. package/esm/typings/src/commands/FORMAT/FormatCommand.d.ts +9 -0
  62. package/esm/typings/src/commands/FORMAT/formatCommand.test.d.ts +1 -0
  63. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +9 -0
  64. package/esm/typings/src/commands/FORMFACTOR/FormfactorCommand.d.ts +11 -0
  65. package/esm/typings/src/commands/FORMFACTOR/formfactorCommand.test.d.ts +1 -0
  66. package/esm/typings/src/commands/FORMFACTOR/formfactorCommandParser.d.ts +11 -0
  67. package/esm/typings/src/commands/JOKER/JokerCommand.d.ts +11 -0
  68. package/esm/typings/src/commands/JOKER/jokerCommand.test.d.ts +1 -0
  69. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +9 -0
  70. package/esm/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +11 -0
  71. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts +1 -0
  72. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +12 -0
  73. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.d.ts +11 -0
  74. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.test.d.ts +4 -0
  75. package/esm/typings/src/commands/MODEL/ModelCommand.d.ts +13 -0
  76. package/esm/typings/src/commands/MODEL/modelCommand.test.d.ts +1 -0
  77. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +9 -0
  78. package/esm/typings/src/commands/PARAMETER/ParameterCommand.d.ts +15 -0
  79. package/esm/typings/src/commands/PARAMETER/parameterCommand.test.d.ts +1 -0
  80. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +9 -0
  81. package/esm/typings/src/commands/PERSONA/PersonaCommand.d.ts +13 -0
  82. package/esm/typings/src/commands/PERSONA/personaCommand.test.d.ts +1 -0
  83. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +9 -0
  84. package/esm/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts +11 -0
  85. package/esm/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts +1 -0
  86. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +9 -0
  87. package/esm/typings/src/commands/SECTION/SectionCommand.d.ts +11 -0
  88. package/esm/typings/src/commands/SECTION/sectionCommand.test.d.ts +1 -0
  89. package/esm/typings/src/commands/SECTION/sectionCommandParser.d.ts +20 -0
  90. package/esm/typings/src/commands/URL/UrlCommand.d.ts +10 -0
  91. package/esm/typings/src/commands/URL/urlCommand.test.d.ts +1 -0
  92. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +9 -0
  93. package/esm/typings/src/commands/X_ACTION/ActionCommand.d.ts +9 -0
  94. package/esm/typings/src/commands/X_ACTION/actionCommand.test.d.ts +1 -0
  95. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +12 -0
  96. package/esm/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +9 -0
  97. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts +1 -0
  98. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +12 -0
  99. package/esm/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +10 -0
  100. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts +1 -0
  101. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +11 -0
  102. package/esm/typings/src/commands/_common/getParserForCommand.d.ts +11 -0
  103. package/esm/typings/src/commands/_common/getParserForCommand.test.d.ts +1 -0
  104. package/esm/typings/src/commands/_common/parseCommand.d.ts +12 -0
  105. package/esm/typings/src/commands/_common/parseCommand.test.d.ts +1 -0
  106. package/esm/typings/src/commands/_common/stringifyCommand.d.ts +11 -0
  107. package/esm/typings/src/commands/_common/stringifyCommand.test.d.ts +1 -0
  108. package/esm/typings/src/commands/_common/types/Command.d.ts +6 -0
  109. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +189 -0
  110. package/esm/typings/src/commands/_common/types/CommandType.d.ts +17 -0
  111. package/esm/typings/src/commands/_common/types/CommandUsagePlaces.d.ts +11 -0
  112. package/esm/typings/src/commands/index.d.ts +9 -0
  113. package/esm/typings/src/config.d.ts +227 -0
  114. package/esm/typings/src/config.test.d.ts +4 -0
  115. package/esm/typings/src/constants.d.ts +35 -0
  116. package/esm/typings/src/conversion/compilePipeline.d.ts +28 -0
  117. package/esm/typings/src/conversion/compilePipeline.test.d.ts +1 -0
  118. package/esm/typings/src/conversion/pipelineJsonToString.d.ts +18 -0
  119. package/esm/typings/src/conversion/precompilePipeline.d.ts +30 -0
  120. package/esm/typings/src/conversion/precompilePipeline.test.d.ts +1 -0
  121. package/esm/typings/src/conversion/prettify/PrettifyOptions.d.ts +13 -0
  122. package/esm/typings/src/conversion/prettify/prettifyPipelineString.d.ts +12 -0
  123. package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +30 -0
  124. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.d.ts +15 -0
  125. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.test.d.ts +1 -0
  126. package/esm/typings/src/conversion/utils/extractVariablesFromScript.d.ts +14 -0
  127. package/esm/typings/src/conversion/utils/extractVariablesFromScript.test.d.ts +1 -0
  128. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +30 -0
  129. package/esm/typings/src/conversion/validation/pipelineStringToJson-parseErrors.test.d.ts +4 -0
  130. package/esm/typings/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +4 -0
  131. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +42 -0
  132. package/esm/typings/src/conversion/validation/validatePipeline.test.d.ts +4 -0
  133. package/esm/typings/src/dialogs/callback/CallbackInterfaceTools.d.ts +17 -0
  134. package/esm/typings/src/dialogs/callback/CallbackInterfaceToolsOptions.d.ts +14 -0
  135. package/esm/typings/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +22 -0
  136. package/esm/typings/src/dialogs/user-interface-execution-tools.test.d.ts +1 -0
  137. package/esm/typings/src/errors/0-BoilerplateError.d.ts +12 -0
  138. package/esm/typings/src/errors/0-index.d.ts +85 -0
  139. package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
  140. package/esm/typings/src/errors/CollectionError.d.ts +9 -0
  141. package/esm/typings/src/errors/EnvironmentMismatchError.d.ts +9 -0
  142. package/esm/typings/src/errors/ExpectError.d.ts +12 -0
  143. package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
  144. package/esm/typings/src/errors/LimitReachedError.d.ts +9 -0
  145. package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
  146. package/esm/typings/src/errors/NotFoundError.d.ts +9 -0
  147. package/esm/typings/src/errors/NotYetImplementedError.d.ts +9 -0
  148. package/esm/typings/src/errors/ParseError.d.ts +12 -0
  149. package/esm/typings/src/errors/PipelineExecutionError.d.ts +9 -0
  150. package/esm/typings/src/errors/PipelineLogicError.d.ts +9 -0
  151. package/esm/typings/src/errors/PipelineUrlError.d.ts +9 -0
  152. package/esm/typings/src/errors/UnexpectedError.d.ts +9 -0
  153. package/esm/typings/src/errors/utils/ErrorJson.d.ts +20 -0
  154. package/esm/typings/src/errors/utils/deserializeError.d.ts +7 -0
  155. package/esm/typings/src/errors/utils/deserializeError.test.d.ts +1 -0
  156. package/esm/typings/src/errors/utils/getErrorReportUrl.d.ts +6 -0
  157. package/esm/typings/src/errors/utils/serializeError.d.ts +7 -0
  158. package/esm/typings/src/errors/utils/serializeError.test.d.ts +1 -0
  159. package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +12 -0
  160. package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +11 -0
  161. package/esm/typings/src/executables/apps/locateLibreoffice.test.d.ts +1 -0
  162. package/esm/typings/src/executables/apps/locatePandoc.d.ts +11 -0
  163. package/esm/typings/src/executables/apps/locatePandoc.test.d.ts +1 -0
  164. package/esm/typings/src/executables/locateApp.d.ts +33 -0
  165. package/esm/typings/src/executables/locateApp.test.d.ts +1 -0
  166. package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +12 -0
  167. package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +12 -0
  168. package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +12 -0
  169. package/esm/typings/src/execution/AvailableModel.d.ts +38 -0
  170. package/esm/typings/src/execution/CommonToolsOptions.d.ts +24 -0
  171. package/esm/typings/src/execution/EmbeddingVector.d.ts +8 -0
  172. package/esm/typings/src/execution/Executables.d.ts +18 -0
  173. package/esm/typings/src/execution/ExecutionTools.d.ts +69 -0
  174. package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
  175. package/esm/typings/src/execution/LlmExecutionTools.d.ts +61 -0
  176. package/esm/typings/src/execution/LlmExecutionToolsConstructor.d.ts +10 -0
  177. package/esm/typings/src/execution/PipelineExecutor.d.ts +19 -0
  178. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +50 -0
  179. package/esm/typings/src/execution/PromptResult.d.ts +101 -0
  180. package/esm/typings/src/execution/PromptResultUsage.d.ts +33 -0
  181. package/esm/typings/src/execution/PromptbookFetch.d.ts +5 -0
  182. package/esm/typings/src/execution/PromptbookFetch.test-type.d.ts +5 -0
  183. package/esm/typings/src/execution/ScriptExecutionTools.d.ts +39 -0
  184. package/esm/typings/src/execution/UncertainNumber.d.ts +19 -0
  185. package/esm/typings/src/execution/UserInterfaceTools.d.ts +46 -0
  186. package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +13 -0
  187. package/esm/typings/src/execution/createPipelineExecutor/$OngoingTaskResult.d.ts +45 -0
  188. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +46 -0
  189. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +13 -0
  190. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +49 -0
  191. package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts +51 -0
  192. package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +15 -0
  193. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +64 -0
  194. package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +34 -0
  195. package/esm/typings/src/execution/createPipelineExecutor/getContextForTask.d.ts +10 -0
  196. package/esm/typings/src/execution/createPipelineExecutor/getExamplesForTask.d.ts +10 -0
  197. package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +27 -0
  198. package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts +30 -0
  199. package/esm/typings/src/execution/embeddingVectorToString.d.ts +7 -0
  200. package/esm/typings/src/execution/execution-report/ExecutionPromptReportJson.d.ts +24 -0
  201. package/esm/typings/src/execution/execution-report/ExecutionReportJson.d.ts +41 -0
  202. package/esm/typings/src/execution/execution-report/ExecutionReportString.d.ts +16 -0
  203. package/esm/typings/src/execution/execution-report/ExecutionReportStringOptions.d.ts +25 -0
  204. package/esm/typings/src/execution/execution-report/countWorkingDuration.d.ts +7 -0
  205. package/esm/typings/src/execution/execution-report/countWorkingDuration.test.d.ts +1 -0
  206. package/esm/typings/src/execution/execution-report/executionReportJsonToString.d.ts +15 -0
  207. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +7 -0
  208. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +11 -0
  209. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +8 -0
  210. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +22 -0
  211. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +7 -0
  212. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +8 -0
  213. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts +1 -0
  214. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +12 -0
  215. package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
  216. package/esm/typings/src/execution/utils/addUsage.d.ts +9 -0
  217. package/esm/typings/src/execution/utils/addUsage.test.d.ts +1 -0
  218. package/esm/typings/src/execution/utils/checkExpectations.d.ts +29 -0
  219. package/esm/typings/src/execution/utils/checkExpectations.test.d.ts +1 -0
  220. package/esm/typings/src/execution/utils/computeUsageCounts.d.ts +10 -0
  221. package/esm/typings/src/execution/utils/forEachAsync.d.ts +20 -0
  222. package/esm/typings/src/execution/utils/uncertainNumber.d.ts +9 -0
  223. package/esm/typings/src/execution/utils/usage-constants.d.ts +130 -0
  224. package/esm/typings/src/execution/utils/usageToHuman.d.ts +16 -0
  225. package/esm/typings/src/execution/utils/usageToWorktime.d.ts +12 -0
  226. package/esm/typings/src/execution/utils/usageToWorktime.test.d.ts +1 -0
  227. package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts +10 -0
  228. package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts +10 -0
  229. package/esm/typings/src/formats/_common/FormatDefinition.d.ts +70 -0
  230. package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +31 -0
  231. package/esm/typings/src/formats/csv/CsvFormatDefinition.d.ts +17 -0
  232. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  233. package/esm/typings/src/formats/csv/CsvSettings.d.ts +13 -0
  234. package/esm/typings/src/formats/index.d.ts +9 -0
  235. package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts +19 -0
  236. package/esm/typings/src/formats/json/utils/isValidJsonString.d.ts +6 -0
  237. package/esm/typings/src/formats/json/utils/isValidJsonString.test.d.ts +1 -0
  238. package/esm/typings/src/formats/text/TextFormatDefinition.d.ts +19 -0
  239. package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts +19 -0
  240. package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts +14 -0
  241. package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +40 -0
  242. package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts +8 -0
  243. package/esm/typings/src/formfactors/_common/string_formfactor_name.d.ts +5 -0
  244. package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts +45 -0
  245. package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts +19 -0
  246. package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts +14 -0
  247. package/esm/typings/src/formfactors/index.d.ts +123 -0
  248. package/esm/typings/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts +19 -0
  249. package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts +25 -0
  250. package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts +24 -0
  251. package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +20 -0
  252. package/esm/typings/src/high-level-abstractions/implicit-formfactor/ImplicitFormfactorHla.d.ts +10 -0
  253. package/esm/typings/src/high-level-abstractions/index.d.ts +44 -0
  254. package/esm/typings/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts +10 -0
  255. package/esm/typings/src/llm-providers/_common/register/$llmToolsMetadataRegister.d.ts +13 -0
  256. package/esm/typings/src/llm-providers/_common/register/$llmToolsRegister.d.ts +13 -0
  257. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +25 -0
  258. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForCli.d.ts +15 -0
  259. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +24 -0
  260. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +27 -0
  261. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +13 -0
  262. package/esm/typings/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +23 -0
  263. package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +36 -0
  264. package/esm/typings/src/llm-providers/_common/register/LlmToolsOptions.d.ts +10 -0
  265. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +40 -0
  266. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.test.d.ts +1 -0
  267. package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts +28 -0
  268. package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +19 -0
  269. package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts +19 -0
  270. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +15 -0
  271. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/countTotalUsage.d.ts +17 -0
  272. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +36 -0
  273. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +60 -0
  274. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +31 -0
  275. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +24 -0
  276. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts +18 -0
  277. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.test.d.ts +4 -0
  278. package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +19 -0
  279. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +7 -0
  280. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +13 -0
  281. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +14 -0
  282. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +63 -0
  283. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +37 -0
  284. package/esm/typings/src/llm-providers/azure-openai/createAzureOpenAiExecutionTools.d.ts +15 -0
  285. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +6 -0
  286. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +13 -0
  287. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +14 -0
  288. package/esm/typings/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts +9 -0
  289. package/esm/typings/src/llm-providers/google/createGoogleExecutionTools.d.ts +14 -0
  290. package/esm/typings/src/llm-providers/google/register-configuration.d.ts +13 -0
  291. package/esm/typings/src/llm-providers/google/register-constructor.d.ts +14 -0
  292. package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +15 -0
  293. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +40 -0
  294. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +44 -0
  295. package/esm/typings/src/llm-providers/mocked/test/fakeTextToExpectations.test.d.ts +1 -0
  296. package/esm/typings/src/llm-providers/mocked/test/faked-completion.test.d.ts +1 -0
  297. package/esm/typings/src/llm-providers/mocked/test/joker.test.d.ts +4 -0
  298. package/esm/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts +5 -0
  299. package/esm/typings/src/llm-providers/mocked/test/mocked-completion.test.d.ts +4 -0
  300. package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +63 -0
  301. package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +21 -0
  302. package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts +5 -0
  303. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +36 -0
  304. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +14 -0
  305. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +84 -0
  306. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +11 -0
  307. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.d.ts +18 -0
  308. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.test.d.ts +4 -0
  309. package/esm/typings/src/llm-providers/openai/computeUsage.d.ts +16 -0
  310. package/esm/typings/src/llm-providers/openai/computeUsage.test.d.ts +1 -0
  311. package/esm/typings/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +15 -0
  312. package/esm/typings/src/llm-providers/openai/createOpenAiExecutionTools.d.ts +15 -0
  313. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +31 -0
  314. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +6 -0
  315. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +22 -0
  316. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +23 -0
  317. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +63 -0
  318. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Error.d.ts +7 -0
  319. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts +38 -0
  320. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts +15 -0
  321. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Progress.d.ts +12 -0
  322. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts +45 -0
  323. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Response.d.ts +12 -0
  324. package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts +54 -0
  325. package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts +73 -0
  326. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +5 -0
  327. package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts +23 -0
  328. package/esm/typings/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts +23 -0
  329. package/esm/typings/src/llm-providers/vercel/VercelProvider.d.ts +13 -0
  330. package/esm/typings/src/llm-providers/vercel/createExecutionToolsFromVercelProvider.d.ts +8 -0
  331. package/esm/typings/src/llm-providers/vercel/playground/playground.d.ts +6 -0
  332. package/esm/typings/src/personas/preparePersona.d.ts +17 -0
  333. package/esm/typings/src/pipeline/PipelineInterface/PipelineInterface.d.ts +22 -0
  334. package/esm/typings/src/pipeline/PipelineInterface/constants.d.ts +14 -0
  335. package/esm/typings/src/pipeline/PipelineInterface/getPipelineInterface.d.ts +11 -0
  336. package/esm/typings/src/pipeline/PipelineInterface/isPipelineImplementingInterface.d.ts +26 -0
  337. package/esm/typings/src/pipeline/PipelineInterface/isPipelineInterfacesEqual.d.ts +10 -0
  338. package/esm/typings/src/pipeline/PipelineJson/CommonTaskJson.d.ts +100 -0
  339. package/esm/typings/src/pipeline/PipelineJson/DialogTaskJson.d.ts +13 -0
  340. package/esm/typings/src/pipeline/PipelineJson/Expectations.d.ts +40 -0
  341. package/esm/typings/src/pipeline/PipelineJson/KnowledgePieceJson.d.ts +73 -0
  342. package/esm/typings/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts +44 -0
  343. package/esm/typings/src/pipeline/PipelineJson/ParameterJson.d.ts +98 -0
  344. package/esm/typings/src/pipeline/PipelineJson/PersonaJson.d.ts +45 -0
  345. package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts +102 -0
  346. package/esm/typings/src/pipeline/PipelineJson/PreparationJson.d.ts +22 -0
  347. package/esm/typings/src/pipeline/PipelineJson/PromptTaskJson.d.ts +26 -0
  348. package/esm/typings/src/pipeline/PipelineJson/ScriptTaskJson.d.ts +20 -0
  349. package/esm/typings/src/pipeline/PipelineJson/SimpleTaskJson.d.ts +13 -0
  350. package/esm/typings/src/pipeline/PipelineJson/TaskJson.d.ts +11 -0
  351. package/esm/typings/src/pipeline/PipelineString.d.ts +12 -0
  352. package/esm/typings/src/postprocessing/utils/extractBlock.d.ts +16 -0
  353. package/esm/typings/src/postprocessing/utils/extractJsonBlock.d.ts +25 -0
  354. package/esm/typings/src/postprocessing/utils/extractJsonBlock.test.d.ts +1 -0
  355. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +51 -0
  356. package/esm/typings/src/prepare/isPipelinePrepared.d.ts +16 -0
  357. package/esm/typings/src/prepare/isPipelinePrepared.test.d.ts +1 -0
  358. package/esm/typings/src/prepare/preparePipeline.d.ts +20 -0
  359. package/esm/typings/src/prepare/prepareTasks.d.ts +33 -0
  360. package/esm/typings/src/prepare/unpreparePipeline.d.ts +13 -0
  361. package/esm/typings/src/scrapers/_common/Converter.d.ts +22 -0
  362. package/esm/typings/src/scrapers/_common/Scraper.d.ts +59 -0
  363. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +11 -0
  364. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts +19 -0
  365. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.test.d.ts +1 -0
  366. package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +11 -0
  367. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +12 -0
  368. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +15 -0
  369. package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +13 -0
  370. package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
  371. package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +13 -0
  372. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +41 -0
  373. package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +12 -0
  374. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +34 -0
  375. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  376. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +11 -0
  377. package/esm/typings/src/scrapers/_common/utils/scraperFetch.d.ts +7 -0
  378. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
  379. package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
  380. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
  381. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  382. package/esm/typings/src/scrapers/document/register-constructor.d.ts +14 -0
  383. package/esm/typings/src/scrapers/document/register-metadata.d.ts +27 -0
  384. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
  385. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
  386. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +20 -0
  387. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  388. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +14 -0
  389. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +27 -0
  390. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
  391. package/esm/typings/src/scrapers/markdown/MarkdownScraper.test.d.ts +4 -0
  392. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
  393. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  394. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +14 -0
  395. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +27 -0
  396. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +40 -0
  397. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +20 -0
  398. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  399. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +14 -0
  400. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +27 -0
  401. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +50 -0
  402. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +20 -0
  403. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  404. package/esm/typings/src/scrapers/website/register-constructor.d.ts +14 -0
  405. package/esm/typings/src/scrapers/website/register-metadata.d.ts +27 -0
  406. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.d.ts +7 -0
  407. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.test.d.ts +1 -0
  408. package/esm/typings/src/scripting/_test/custom-function-async.test.ts.test.d.ts +1 -0
  409. package/esm/typings/src/scripting/_test/custom-function-missing.test.d.ts +1 -0
  410. package/esm/typings/src/scripting/_test/custom-function-with-dependencies.test.d.ts +1 -0
  411. package/esm/typings/src/scripting/_test/custom-function.test.d.ts +1 -0
  412. package/esm/typings/src/scripting/_test/postprocessing.test.d.ts +1 -0
  413. package/esm/typings/src/scripting/_test/script-execution-errors.test.d.ts +1 -0
  414. package/esm/typings/src/scripting/_test/script-execution-tools.test.d.ts +1 -0
  415. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +22 -0
  416. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -0
  417. package/esm/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts +8 -0
  418. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +26 -0
  419. package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts +52 -0
  420. package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +13 -0
  421. package/esm/typings/src/scripting/javascript/utils/unknownToString.d.ts +8 -0
  422. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +18 -0
  423. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +18 -0
  424. package/esm/typings/src/storage/_common/PromptbookStorage.d.ts +24 -0
  425. package/esm/typings/src/storage/_common/PromptbookStorage.test-type.d.ts +5 -0
  426. package/esm/typings/src/storage/blackhole/BlackholeStorage.d.ts +33 -0
  427. package/esm/typings/src/storage/file-cache-storage/FileCacheStorage.d.ts +33 -0
  428. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +10 -0
  429. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts +7 -0
  430. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts +1 -0
  431. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +10 -0
  432. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +10 -0
  433. package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts +11 -0
  434. package/esm/typings/src/storage/memory/MemoryStorage.d.ts +33 -0
  435. package/esm/typings/src/storage/utils/PrefixStorage.d.ts +25 -0
  436. package/esm/typings/src/types/Arrayable.d.ts +10 -0
  437. package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +7 -0
  438. package/esm/typings/src/types/ModelRequirements.d.ts +104 -0
  439. package/esm/typings/src/types/ModelVariant.d.ts +15 -0
  440. package/esm/typings/src/types/Prompt.d.ts +111 -0
  441. package/esm/typings/src/types/ScriptLanguage.d.ts +13 -0
  442. package/esm/typings/src/types/SectionType.d.ts +21 -0
  443. package/esm/typings/src/types/TaskProgress.d.ts +43 -0
  444. package/esm/typings/src/types/TaskType.d.ts +15 -0
  445. package/esm/typings/src/types/typeAliasEmoji.d.ts +12 -0
  446. package/esm/typings/src/types/typeAliases.d.ts +622 -0
  447. package/esm/typings/src/utils/$Register.d.ts +39 -0
  448. package/esm/typings/src/utils/$getCurrentDate.d.ts +10 -0
  449. package/esm/typings/src/utils/FromtoItems.d.ts +19 -0
  450. package/esm/typings/src/utils/arrayableToArray.d.ts +11 -0
  451. package/esm/typings/src/utils/arrayableToArray.test.d.ts +1 -0
  452. package/esm/typings/src/utils/editable/types/PipelineEditableSerialized.d.ts +42 -0
  453. package/esm/typings/src/utils/editable/utils/removePipelineCommand.d.ts +22 -0
  454. package/esm/typings/src/utils/editable/utils/removePipelineCommand.test.d.ts +1 -0
  455. package/esm/typings/src/utils/editable/utils/renamePipelineParameter.d.ts +26 -0
  456. package/esm/typings/src/utils/editable/utils/renamePipelineParameter.test.d.ts +1 -0
  457. package/esm/typings/src/utils/editable/utils/stringifyPipelineJson.d.ts +16 -0
  458. package/esm/typings/src/utils/editable/utils/stringifyPipelineJson.test.d.ts +1 -0
  459. package/esm/typings/src/utils/emojis.d.ts +24 -0
  460. package/esm/typings/src/utils/environment/$getGlobalScope.d.ts +9 -0
  461. package/esm/typings/src/utils/environment/$isRunningInBrowser.d.ts +8 -0
  462. package/esm/typings/src/utils/environment/$isRunningInJest.d.ts +8 -0
  463. package/esm/typings/src/utils/environment/$isRunningInNode.d.ts +8 -0
  464. package/esm/typings/src/utils/environment/$isRunningInWebWorker.d.ts +8 -0
  465. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +16 -0
  466. package/esm/typings/src/utils/execCommand/$execCommandNormalizeOptions.d.ts +12 -0
  467. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +18 -0
  468. package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts +45 -0
  469. package/esm/typings/src/utils/execCommand/execCommand.test.d.ts +1 -0
  470. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts +1 -0
  471. package/esm/typings/src/utils/expectation-counters/constants.d.ts +16 -0
  472. package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts +7 -0
  473. package/esm/typings/src/utils/expectation-counters/countCharacters.test.d.ts +1 -0
  474. package/esm/typings/src/utils/expectation-counters/countLines.d.ts +9 -0
  475. package/esm/typings/src/utils/expectation-counters/countLines.test.d.ts +1 -0
  476. package/esm/typings/src/utils/expectation-counters/countPages.d.ts +9 -0
  477. package/esm/typings/src/utils/expectation-counters/countPages.test.d.ts +1 -0
  478. package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts +7 -0
  479. package/esm/typings/src/utils/expectation-counters/countParagraphs.test.d.ts +1 -0
  480. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +13 -0
  481. package/esm/typings/src/utils/expectation-counters/countSentences.test.d.ts +1 -0
  482. package/esm/typings/src/utils/expectation-counters/countWords.d.ts +7 -0
  483. package/esm/typings/src/utils/expectation-counters/countWords.test.d.ts +1 -0
  484. package/esm/typings/src/utils/expectation-counters/index.d.ts +12 -0
  485. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  486. package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts +1 -0
  487. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  488. package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
  489. package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
  490. package/esm/typings/src/utils/files/isDirectoryExisting.test.d.ts +1 -0
  491. package/esm/typings/src/utils/files/isExecutable.d.ts +11 -0
  492. package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
  493. package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
  494. package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
  495. package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
  496. package/esm/typings/src/utils/formatNumber.d.ts +6 -0
  497. package/esm/typings/src/utils/formatNumber.test.d.ts +1 -0
  498. package/esm/typings/src/utils/getBookTemplate.d.ts +12 -0
  499. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +14 -0
  500. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.test.d.ts +1 -0
  501. package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts +38 -0
  502. package/esm/typings/src/utils/markdown/createMarkdownChart.test.d.ts +1 -0
  503. package/esm/typings/src/utils/markdown/createMarkdownTable.d.ts +11 -0
  504. package/esm/typings/src/utils/markdown/createMarkdownTable.test.d.ts +1 -0
  505. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.d.ts +11 -0
  506. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.test.d.ts +1 -0
  507. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts +1 -0
  508. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +36 -0
  509. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts +1 -0
  510. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +15 -0
  511. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts +1 -0
  512. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +22 -0
  513. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.test.d.ts +1 -0
  514. package/esm/typings/src/utils/markdown/flattenMarkdown.d.ts +17 -0
  515. package/esm/typings/src/utils/markdown/flattenMarkdown.test.d.ts +1 -0
  516. package/esm/typings/src/utils/markdown/parseMarkdownSection.d.ts +34 -0
  517. package/esm/typings/src/utils/markdown/parseMarkdownSection.test.d.ts +1 -0
  518. package/esm/typings/src/utils/markdown/prettifyMarkdown.d.ts +9 -0
  519. package/esm/typings/src/utils/markdown/prettifyMarkdown.test.d.ts +1 -0
  520. package/esm/typings/src/utils/markdown/removeContentComments.d.ts +10 -0
  521. package/esm/typings/src/utils/markdown/removeContentComments.test.d.ts +1 -0
  522. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.d.ts +9 -0
  523. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.test.d.ts +1 -0
  524. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +15 -0
  525. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts +1 -0
  526. package/esm/typings/src/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts +12 -0
  527. package/esm/typings/src/utils/normalization/IKeywords.d.ts +21 -0
  528. package/esm/typings/src/utils/normalization/capitalize.d.ts +6 -0
  529. package/esm/typings/src/utils/normalization/capitalize.test.d.ts +1 -0
  530. package/esm/typings/src/utils/normalization/decapitalize.d.ts +6 -0
  531. package/esm/typings/src/utils/normalization/decapitalize.test.d.ts +1 -0
  532. package/esm/typings/src/utils/normalization/isValidKeyword.d.ts +10 -0
  533. package/esm/typings/src/utils/normalization/isValidKeyword.test.d.ts +1 -0
  534. package/esm/typings/src/utils/normalization/nameToUriPart.d.ts +9 -0
  535. package/esm/typings/src/utils/normalization/nameToUriPart.test.d.ts +1 -0
  536. package/esm/typings/src/utils/normalization/nameToUriParts.d.ts +9 -0
  537. package/esm/typings/src/utils/normalization/nameToUriParts.test.d.ts +1 -0
  538. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts +21 -0
  539. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.test.d.ts +1 -0
  540. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts +17 -0
  541. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.test.d.ts +1 -0
  542. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +26 -0
  543. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts +1 -0
  544. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.d.ts +22 -0
  545. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.test.d.ts +1 -0
  546. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts +17 -0
  547. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.test.d.ts +1 -0
  548. package/esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts +6 -0
  549. package/esm/typings/src/utils/normalization/normalizeWhitespaces.test.d.ts +1 -0
  550. package/esm/typings/src/utils/normalization/orderJson.d.ts +21 -0
  551. package/esm/typings/src/utils/normalization/orderJson.test.d.ts +4 -0
  552. package/esm/typings/src/utils/normalization/parseKeywords.d.ts +16 -0
  553. package/esm/typings/src/utils/normalization/parseKeywords.test.d.ts +1 -0
  554. package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +9 -0
  555. package/esm/typings/src/utils/normalization/parseKeywordsFromString.test.d.ts +1 -0
  556. package/esm/typings/src/utils/normalization/removeDiacritics.d.ts +11 -0
  557. package/esm/typings/src/utils/normalization/removeDiacritics.test.d.ts +1 -0
  558. package/esm/typings/src/utils/normalization/searchKeywords.d.ts +10 -0
  559. package/esm/typings/src/utils/normalization/searchKeywords.test.d.ts +1 -0
  560. package/esm/typings/src/utils/normalization/titleToName.d.ts +9 -0
  561. package/esm/typings/src/utils/normalization/titleToName.test.d.ts +1 -0
  562. package/esm/typings/src/utils/organization/TODO_USE.d.ts +12 -0
  563. package/esm/typings/src/utils/organization/TODO_any.d.ts +6 -0
  564. package/esm/typings/src/utils/organization/TODO_object.d.ts +6 -0
  565. package/esm/typings/src/utils/organization/TODO_remove_as.d.ts +6 -0
  566. package/esm/typings/src/utils/organization/TODO_string.d.ts +6 -0
  567. package/esm/typings/src/utils/organization/TODO_unknown.d.ts +6 -0
  568. package/esm/typings/src/utils/organization/___and___.d.ts +7 -0
  569. package/esm/typings/src/utils/organization/___or___.d.ts +6 -0
  570. package/esm/typings/src/utils/organization/empty_object.d.ts +10 -0
  571. package/esm/typings/src/utils/organization/just.d.ts +14 -0
  572. package/esm/typings/src/utils/organization/just_empty_object.d.ts +12 -0
  573. package/esm/typings/src/utils/organization/keepTypeImported.d.ts +9 -0
  574. package/esm/typings/src/utils/organization/keepUnused.d.ts +16 -0
  575. package/esm/typings/src/utils/organization/really_any.d.ts +6 -0
  576. package/esm/typings/src/utils/organization/really_unknown.d.ts +6 -0
  577. package/esm/typings/src/utils/organization/spaceTrim.d.ts +11 -0
  578. package/esm/typings/src/utils/parameters/extractParameterNames.d.ts +10 -0
  579. package/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts +1 -0
  580. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +27 -0
  581. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts +1 -0
  582. package/esm/typings/src/utils/parameters/templateParameters.d.ts +12 -0
  583. package/esm/typings/src/utils/parameters/templateParameters.test.d.ts +1 -0
  584. package/esm/typings/src/utils/parseNumber.d.ts +16 -0
  585. package/esm/typings/src/utils/parseNumber.test.d.ts +1 -0
  586. package/esm/typings/src/utils/random/$randomSeed.d.ts +9 -0
  587. package/esm/typings/src/utils/removeEmojis.d.ts +8 -0
  588. package/esm/typings/src/utils/removeEmojis.test.d.ts +1 -0
  589. package/esm/typings/src/utils/removeQuotes.d.ts +14 -0
  590. package/esm/typings/src/utils/removeQuotes.test.d.ts +1 -0
  591. package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +14 -0
  592. package/esm/typings/src/utils/serialization/asSerializable.d.ts +11 -0
  593. package/esm/typings/src/utils/serialization/asSerializable.test.d.ts +1 -0
  594. package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts +45 -0
  595. package/esm/typings/src/utils/serialization/clonePipeline.d.ts +13 -0
  596. package/esm/typings/src/utils/serialization/deepClone.d.ts +10 -0
  597. package/esm/typings/src/utils/serialization/deepClone.test.d.ts +1 -0
  598. package/esm/typings/src/utils/serialization/exportJson.d.ts +29 -0
  599. package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts +25 -0
  600. package/esm/typings/src/utils/serialization/isSerializableAsJson.test.d.ts +1 -0
  601. package/esm/typings/src/utils/sets/difference.d.ts +10 -0
  602. package/esm/typings/src/utils/sets/difference.test.d.ts +1 -0
  603. package/esm/typings/src/utils/sets/intersection.d.ts +7 -0
  604. package/esm/typings/src/utils/sets/intersection.test.d.ts +1 -0
  605. package/esm/typings/src/utils/sets/union.d.ts +7 -0
  606. package/esm/typings/src/utils/sets/union.test.d.ts +1 -0
  607. package/esm/typings/src/utils/trimCodeBlock.d.ts +9 -0
  608. package/esm/typings/src/utils/trimCodeBlock.test.d.ts +1 -0
  609. package/esm/typings/src/utils/trimEndOfCodeBlock.d.ts +9 -0
  610. package/esm/typings/src/utils/trimEndOfCodeBlock.test.d.ts +1 -0
  611. package/esm/typings/src/utils/unwrapResult.d.ts +37 -0
  612. package/esm/typings/src/utils/unwrapResult.test.d.ts +1 -0
  613. package/esm/typings/src/utils/validators/email/isValidEmail.d.ts +8 -0
  614. package/esm/typings/src/utils/validators/email/isValidEmail.test.d.ts +1 -0
  615. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +9 -0
  616. package/esm/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts +1 -0
  617. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +10 -0
  618. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts +1 -0
  619. package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts +10 -0
  620. package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts +1 -0
  621. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +15 -0
  622. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts +1 -0
  623. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts +12 -0
  624. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts +1 -0
  625. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts +11 -0
  626. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts +1 -0
  627. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +13 -0
  628. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts +1 -0
  629. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.d.ts +15 -0
  630. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts +1 -0
  631. package/esm/typings/src/utils/validators/url/isValidUrl.d.ts +13 -0
  632. package/esm/typings/src/utils/validators/url/isValidUrl.test.d.ts +1 -0
  633. package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts +8 -0
  634. package/esm/typings/src/utils/validators/uuid/isValidUuid.test.d.ts +1 -0
  635. package/esm/typings/src/version.d.ts +18 -0
  636. package/package.json +63 -0
  637. package/umd/index.umd.js +645 -0
  638. package/umd/index.umd.js.map +1 -0
@@ -0,0 +1,629 @@
1
+ import spaceTrim, { spaceTrim as spaceTrim$1 } from 'spacetrim';
2
+
3
+ // ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
4
+ /**
5
+ * The version of the Book language
6
+ *
7
+ * @see https://github.com/webgptorg/book
8
+ */
9
+ var BOOK_LANGUAGE_VERSION = '1.0.0';
10
+ /**
11
+ * The version of the Promptbook engine
12
+ *
13
+ * @see https://github.com/webgptorg/promptbook
14
+ */
15
+ var PROMPTBOOK_ENGINE_VERSION = '0.81.0-4';
16
+ /**
17
+ * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
18
+ * Note: [💞] Ignore a discrepancy between file name and entity name
19
+ */
20
+
21
+ /*! *****************************************************************************
22
+ Copyright (c) Microsoft Corporation.
23
+
24
+ Permission to use, copy, modify, and/or distribute this software for any
25
+ purpose with or without fee is hereby granted.
26
+
27
+ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
28
+ REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
29
+ AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
30
+ INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
31
+ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
32
+ OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
33
+ PERFORMANCE OF THIS SOFTWARE.
34
+ ***************************************************************************** */
35
+ /* global Reflect, Promise */
36
+
37
+ var extendStatics = function(d, b) {
38
+ extendStatics = Object.setPrototypeOf ||
39
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
40
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
41
+ return extendStatics(d, b);
42
+ };
43
+
44
+ function __extends(d, b) {
45
+ if (typeof b !== "function" && b !== null)
46
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
47
+ extendStatics(d, b);
48
+ function __() { this.constructor = d; }
49
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
50
+ }
51
+
52
+ var __assign = function() {
53
+ __assign = Object.assign || function __assign(t) {
54
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
55
+ s = arguments[i];
56
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
57
+ }
58
+ return t;
59
+ };
60
+ return __assign.apply(this, arguments);
61
+ };
62
+
63
+ function __values(o) {
64
+ var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
65
+ if (m) return m.call(o);
66
+ if (o && typeof o.length === "number") return {
67
+ next: function () {
68
+ if (o && i >= o.length) o = void 0;
69
+ return { value: o && o[i++], done: !o };
70
+ }
71
+ };
72
+ throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
73
+ }
74
+
75
+ function __read(o, n) {
76
+ var m = typeof Symbol === "function" && o[Symbol.iterator];
77
+ if (!m) return o;
78
+ var i = m.call(o), r, ar = [], e;
79
+ try {
80
+ while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
81
+ }
82
+ catch (error) { e = { error: error }; }
83
+ finally {
84
+ try {
85
+ if (r && !r.done && (m = i["return"])) m.call(i);
86
+ }
87
+ finally { if (e) throw e.error; }
88
+ }
89
+ return ar;
90
+ }
91
+
92
+ function __spreadArray(to, from, pack) {
93
+ if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
94
+ if (ar || !(i in from)) {
95
+ if (!ar) ar = Array.prototype.slice.call(from, 0, i);
96
+ ar[i] = from[i];
97
+ }
98
+ }
99
+ return to.concat(ar || Array.prototype.slice.call(from));
100
+ }
101
+
102
+ /**
103
+ * Function `removePipelineCommand` will remove one command from pipeline string
104
+ *
105
+ * @public exported from `@promptbook/editable`
106
+ */
107
+ function removePipelineCommand(options) {
108
+ var e_1, _a;
109
+ var command = options.command, pipeline = options.pipeline;
110
+ var lines = pipeline.split('\n');
111
+ // TODO: [🧽] DRY
112
+ var currentType = 'MARKDOWN';
113
+ var newLines = [];
114
+ try {
115
+ for (var lines_1 = __values(lines), lines_1_1 = lines_1.next(); !lines_1_1.done; lines_1_1 = lines_1.next()) {
116
+ var line = lines_1_1.value;
117
+ if (currentType === 'MARKDOWN') {
118
+ if (line.startsWith('```')) {
119
+ currentType = 'CODE_BLOCK';
120
+ }
121
+ else if (line.includes('<!--')) {
122
+ currentType = 'COMMENT';
123
+ }
124
+ }
125
+ else if (currentType === 'CODE_BLOCK') {
126
+ if (line.startsWith('```')) {
127
+ currentType = 'MARKDOWN';
128
+ }
129
+ }
130
+ else if (currentType === 'COMMENT') {
131
+ if (line.includes('-->')) {
132
+ currentType = 'MARKDOWN';
133
+ }
134
+ }
135
+ if (currentType === 'MARKDOWN' && /^(-|\d\))/m.test(line) && line.toUpperCase().includes(command)) {
136
+ continue;
137
+ }
138
+ newLines.push(line);
139
+ }
140
+ }
141
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
142
+ finally {
143
+ try {
144
+ if (lines_1_1 && !lines_1_1.done && (_a = lines_1.return)) _a.call(lines_1);
145
+ }
146
+ finally { if (e_1) throw e_1.error; }
147
+ }
148
+ var newPipeline = spaceTrim(newLines.join('\n'));
149
+ return newPipeline;
150
+ }
151
+
152
+ /**
153
+ * This error indicates that the promptbook object has valid syntax (=can be parsed) but contains logical errors (like circular dependencies)
154
+ *
155
+ * @public exported from `@promptbook/core`
156
+ */
157
+ var PipelineLogicError = /** @class */ (function (_super) {
158
+ __extends(PipelineLogicError, _super);
159
+ function PipelineLogicError(message) {
160
+ var _this = _super.call(this, message) || this;
161
+ _this.name = 'PipelineLogicError';
162
+ Object.setPrototypeOf(_this, PipelineLogicError.prototype);
163
+ return _this;
164
+ }
165
+ return PipelineLogicError;
166
+ }(Error));
167
+
168
+ /**
169
+ * Function `renamePipelineParameter` will find all usable parameters for given task
170
+ * In other words, it will find all parameters that are not used in the task itseld and all its dependencies
171
+ *
172
+ * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
173
+ * @public exported from `@promptbook/editable`
174
+ */
175
+ function renamePipelineParameter(options) {
176
+ var e_1, _a, e_2, _b;
177
+ var pipeline = options.pipeline, oldParameterName = options.oldParameterName, newParameterName = options.newParameterName;
178
+ if (pipeline.parameters.some(function (parameter) { return parameter.name === newParameterName; })) {
179
+ throw new PipelineLogicError("Can not replace {".concat(oldParameterName, "} to {").concat(newParameterName, "} because {").concat(newParameterName, "} is already used in the pipeline"));
180
+ }
181
+ var renamedPipeline = __assign(__assign({}, pipeline), {
182
+ // <- TODO: [🪓] This should be without `as $PipelineJson`
183
+ parameters: __spreadArray([], __read(pipeline.parameters), false), tasks: __spreadArray([], __read(pipeline.tasks), false) });
184
+ try {
185
+ for (var _c = __values(renamedPipeline.parameters), _d = _c.next(); !_d.done; _d = _c.next()) {
186
+ var parameter = _d.value;
187
+ if (parameter.name !== oldParameterName) {
188
+ continue;
189
+ }
190
+ parameter.name = newParameterName;
191
+ }
192
+ }
193
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
194
+ finally {
195
+ try {
196
+ if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
197
+ }
198
+ finally { if (e_1) throw e_1.error; }
199
+ }
200
+ try {
201
+ for (var _e = __values(renamedPipeline.tasks), _f = _e.next(); !_f.done; _f = _e.next()) {
202
+ var task = _f.value;
203
+ if (task.resultingParameterName === oldParameterName) {
204
+ task.resultingParameterName = newParameterName;
205
+ }
206
+ task.dependentParameterNames = task.dependentParameterNames.map(function (dependentParameterName) {
207
+ return dependentParameterName === oldParameterName ? newParameterName : dependentParameterName;
208
+ });
209
+ task.content = task.content.replace(new RegExp("{".concat(oldParameterName, "}"), 'g'), "{".concat(newParameterName, "}"));
210
+ task.title = task.title.replace(new RegExp("{".concat(oldParameterName, "}"), 'g'), "{".concat(newParameterName, "}"));
211
+ task.description =
212
+ task.description === undefined
213
+ ? undefined
214
+ : task.description.replace(new RegExp("{".concat(oldParameterName, "}"), 'g'), "{".concat(newParameterName, "}"));
215
+ }
216
+ }
217
+ catch (e_2_1) { e_2 = { error: e_2_1 }; }
218
+ finally {
219
+ try {
220
+ if (_f && !_f.done && (_b = _e.return)) _b.call(_e);
221
+ }
222
+ finally { if (e_2) throw e_2.error; }
223
+ }
224
+ return renamedPipeline;
225
+ }
226
+
227
+ /**
228
+ * Name for the Promptbook
229
+ *
230
+ * TODO: [🗽] Unite branding and make single place for it
231
+ *
232
+ * @public exported from `@promptbook/core`
233
+ */
234
+ var NAME = "Promptbook";
235
+ /**
236
+ * Email of the responsible person
237
+ *
238
+ * @public exported from `@promptbook/core`
239
+ */
240
+ var ADMIN_EMAIL = 'me@pavolhejny.com';
241
+ /**
242
+ * Name of the responsible person for the Promptbook on GitHub
243
+ *
244
+ * @public exported from `@promptbook/core`
245
+ */
246
+ var ADMIN_GITHUB_NAME = 'hejny';
247
+ // <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
248
+ /**
249
+ * The maximum number of iterations for a loops
250
+ *
251
+ * @private within the repository - too low-level in comparison with other `MAX_...`
252
+ */
253
+ var LOOP_LIMIT = 1000;
254
+ // <- TODO: [🧜‍♂️]
255
+ /**
256
+ * @@@
257
+ *
258
+ * @public exported from `@promptbook/core`
259
+ */
260
+ Object.freeze({
261
+ delimiter: ',',
262
+ quoteChar: '"',
263
+ newline: '\n',
264
+ skipEmptyLines: true,
265
+ });
266
+ /**
267
+ * Note: [💞] Ignore a discrepancy between file name and entity name
268
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
269
+ */
270
+
271
+ /**
272
+ * Orders JSON object by keys
273
+ *
274
+ * @returns The same type of object as the input re-ordered
275
+ * @public exported from `@promptbook/utils`
276
+ */
277
+ function orderJson(options) {
278
+ var value = options.value, order = options.order;
279
+ var orderedValue = __assign(__assign({}, (order === undefined ? {} : Object.fromEntries(order.map(function (key) { return [key, undefined]; })))), value);
280
+ return orderedValue;
281
+ }
282
+
283
+ /**
284
+ * Freezes the given object and all its nested objects recursively
285
+ *
286
+ * Note: `$` is used to indicate that this function is not a pure function - it mutates given object
287
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
288
+ *
289
+ * @returns The same object as the input, but deeply frozen
290
+ * @public exported from `@promptbook/utils`
291
+ */
292
+ function $deepFreeze(objectValue) {
293
+ var e_1, _a;
294
+ if (Array.isArray(objectValue)) {
295
+ return Object.freeze(objectValue.map(function (item) { return $deepFreeze(item); }));
296
+ }
297
+ var propertyNames = Object.getOwnPropertyNames(objectValue);
298
+ try {
299
+ for (var propertyNames_1 = __values(propertyNames), propertyNames_1_1 = propertyNames_1.next(); !propertyNames_1_1.done; propertyNames_1_1 = propertyNames_1.next()) {
300
+ var propertyName = propertyNames_1_1.value;
301
+ var value = objectValue[propertyName];
302
+ if (value && typeof value === 'object') {
303
+ $deepFreeze(value);
304
+ }
305
+ }
306
+ }
307
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
308
+ finally {
309
+ try {
310
+ if (propertyNames_1_1 && !propertyNames_1_1.done && (_a = propertyNames_1.return)) _a.call(propertyNames_1);
311
+ }
312
+ finally { if (e_1) throw e_1.error; }
313
+ }
314
+ Object.freeze(objectValue);
315
+ return objectValue;
316
+ }
317
+ /**
318
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
319
+ */
320
+
321
+ /**
322
+ * Make error report URL for the given error
323
+ *
324
+ * @private !!!!!!
325
+ */
326
+ function getErrorReportUrl(error) {
327
+ var report = {
328
+ title: "\uD83D\uDC1C Error report from ".concat(NAME),
329
+ body: spaceTrim(function (block) { return "\n\n\n `".concat(error.name || 'Error', "` has occurred in the [").concat(NAME, "], please look into it @").concat(ADMIN_GITHUB_NAME, ".\n\n ```\n ").concat(block(error.message || '(no error message)'), "\n ```\n\n\n ## More info:\n\n - **Promptbook engine version:** ").concat(PROMPTBOOK_ENGINE_VERSION, "\n - **Book language version:** ").concat(BOOK_LANGUAGE_VERSION, "\n - **Time:** ").concat(new Date().toISOString(), "\n\n <details>\n <summary>Stack trace:</summary>\n\n ## Stack trace:\n\n ```stacktrace\n ").concat(block(error.stack || '(empty)'), "\n ```\n </details>\n\n "); }),
330
+ };
331
+ var reportUrl = new URL("https://github.com/webgptorg/promptbook/issues/new");
332
+ reportUrl.searchParams.set('labels', 'bug');
333
+ reportUrl.searchParams.set('assignees', ADMIN_GITHUB_NAME);
334
+ reportUrl.searchParams.set('title', report.title);
335
+ reportUrl.searchParams.set('body', report.body);
336
+ return reportUrl;
337
+ }
338
+
339
+ /**
340
+ * This error type indicates that the error should not happen and its last check before crashing with some other error
341
+ *
342
+ * @public exported from `@promptbook/core`
343
+ */
344
+ var UnexpectedError = /** @class */ (function (_super) {
345
+ __extends(UnexpectedError, _super);
346
+ function UnexpectedError(message) {
347
+ var _this = _super.call(this, spaceTrim$1(function (block) { return "\n ".concat(block(message), "\n\n Note: This error should not happen.\n It's probbably a bug in the pipeline collection\n\n Please report issue:\n ").concat(block(getErrorReportUrl(new Error(message)).href), "\n\n Or contact us on ").concat(ADMIN_EMAIL, "\n\n "); })) || this;
348
+ _this.name = 'UnexpectedError';
349
+ Object.setPrototypeOf(_this, UnexpectedError.prototype);
350
+ return _this;
351
+ }
352
+ return UnexpectedError;
353
+ }(Error));
354
+
355
+ /**
356
+ * Checks if the value is [🚉] serializable as JSON
357
+ * If not, throws an UnexpectedError with a rich error message and tracking
358
+ *
359
+ * - Almost all primitives are serializable BUT:
360
+ * - `undefined` is not serializable
361
+ * - `NaN` is not serializable
362
+ * - Objects and arrays are serializable if all their properties are serializable
363
+ * - Functions are not serializable
364
+ * - Circular references are not serializable
365
+ * - `Date` objects are not serializable
366
+ * - `Map` and `Set` objects are not serializable
367
+ * - `RegExp` objects are not serializable
368
+ * - `Error` objects are not serializable
369
+ * - `Symbol` objects are not serializable
370
+ * - And much more...
371
+ *
372
+ * @throws UnexpectedError if the value is not serializable as JSON
373
+ * @public exported from `@promptbook/utils`
374
+ */
375
+ function checkSerializableAsJson(options) {
376
+ var e_1, _a;
377
+ var value = options.value, name = options.name, message = options.message;
378
+ if (value === undefined) {
379
+ throw new UnexpectedError("".concat(name, " is undefined"));
380
+ }
381
+ else if (value === null) {
382
+ return;
383
+ }
384
+ else if (typeof value === 'boolean') {
385
+ return;
386
+ }
387
+ else if (typeof value === 'number' && !isNaN(value)) {
388
+ return;
389
+ }
390
+ else if (typeof value === 'string') {
391
+ return;
392
+ }
393
+ else if (typeof value === 'symbol') {
394
+ throw new UnexpectedError("".concat(name, " is symbol"));
395
+ }
396
+ else if (typeof value === 'function') {
397
+ throw new UnexpectedError("".concat(name, " is function"));
398
+ }
399
+ else if (typeof value === 'object' && Array.isArray(value)) {
400
+ for (var i = 0; i < value.length; i++) {
401
+ checkSerializableAsJson({ name: "".concat(name, "[").concat(i, "]"), value: value[i], message: message });
402
+ }
403
+ }
404
+ else if (typeof value === 'object') {
405
+ if (value instanceof Date) {
406
+ throw new UnexpectedError(spaceTrim(function (block) { return "\n `".concat(name, "` is Date\n\n Use `string_date_iso8601` instead\n\n Additional message for `").concat(name, "`:\n ").concat(block(message || '(nothing)'), "\n "); }));
407
+ }
408
+ else if (value instanceof Map) {
409
+ throw new UnexpectedError("".concat(name, " is Map"));
410
+ }
411
+ else if (value instanceof Set) {
412
+ throw new UnexpectedError("".concat(name, " is Set"));
413
+ }
414
+ else if (value instanceof RegExp) {
415
+ throw new UnexpectedError("".concat(name, " is RegExp"));
416
+ }
417
+ else if (value instanceof Error) {
418
+ throw new UnexpectedError(spaceTrim(function (block) { return "\n `".concat(name, "` is unserialized Error\n\n Use function `serializeError`\n\n Additional message for `").concat(name, "`:\n ").concat(block(message || '(nothing)'), "\n\n "); }));
419
+ }
420
+ else {
421
+ try {
422
+ for (var _b = __values(Object.entries(value)), _c = _b.next(); !_c.done; _c = _b.next()) {
423
+ var _d = __read(_c.value, 2), subName = _d[0], subValue = _d[1];
424
+ if (subValue === undefined) {
425
+ // Note: undefined in object is serializable - it is just omited
426
+ continue;
427
+ }
428
+ checkSerializableAsJson({ name: "".concat(name, ".").concat(subName), value: subValue, message: message });
429
+ }
430
+ }
431
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
432
+ finally {
433
+ try {
434
+ if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
435
+ }
436
+ finally { if (e_1) throw e_1.error; }
437
+ }
438
+ try {
439
+ JSON.stringify(value); // <- TODO: [0]
440
+ }
441
+ catch (error) {
442
+ if (!(error instanceof Error)) {
443
+ throw error;
444
+ }
445
+ throw new UnexpectedError(spaceTrim(function (block) { return "\n `".concat(name, "` is not serializable\n\n ").concat(block(error.toString()), "\n\n Additional message for `").concat(name, "`:\n ").concat(block(message || '(nothing)'), "\n "); }));
446
+ }
447
+ /*
448
+ TODO: [0] Is there some more elegant way to check circular references?
449
+ const seen = new Set();
450
+ const stack = [{ value }];
451
+ while (stack.length > 0) {
452
+ const { value } = stack.pop()!;
453
+ if (typeof value === 'object' && value !== null) {
454
+ if (seen.has(value)) {
455
+ throw new UnexpectedError(`${name} has circular reference`);
456
+ }
457
+ seen.add(value);
458
+ if (Array.isArray(value)) {
459
+ stack.push(...value.map((value) => ({ value })));
460
+ } else {
461
+ stack.push(...Object.values(value).map((value) => ({ value })));
462
+ }
463
+ }
464
+ }
465
+ */
466
+ return;
467
+ }
468
+ }
469
+ else {
470
+ throw new UnexpectedError(spaceTrim(function (block) { return "\n `".concat(name, "` is unknown type\n\n Additional message for `").concat(name, "`:\n ").concat(block(message || '(nothing)'), "\n "); }));
471
+ }
472
+ }
473
+ /**
474
+ * TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
475
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
476
+ * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
477
+ */
478
+
479
+ /**
480
+ * @@@
481
+ *
482
+ * @public exported from `@promptbook/utils`
483
+ */
484
+ function deepClone(objectValue) {
485
+ return JSON.parse(JSON.stringify(objectValue));
486
+ /*
487
+ !!!!!!!!
488
+ TODO: [🧠] Is there a better implementation?
489
+ > const propertyNames = Object.getOwnPropertyNames(objectValue);
490
+ > for (const propertyName of propertyNames) {
491
+ > const value = (objectValue as really_any)[propertyName];
492
+ > if (value && typeof value === 'object') {
493
+ > deepClone(value);
494
+ > }
495
+ > }
496
+ > return Object.assign({}, objectValue);
497
+ */
498
+ }
499
+ /**
500
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
501
+ */
502
+
503
+ /**
504
+ * Utility to export a JSON object from a function
505
+ *
506
+ * 1) Checks if the value is serializable as JSON
507
+ * 2) Makes a deep clone of the object
508
+ * 2) Orders the object properties
509
+ * 2) Deeply freezes the cloned object
510
+ *
511
+ * Note: This function does not mutates the given object
512
+ *
513
+ * @returns The same type of object as the input but read-only and re-ordered
514
+ * @public exported from `@promptbook/utils`
515
+ */
516
+ function exportJson(options) {
517
+ var name = options.name, value = options.value, order = options.order, message = options.message;
518
+ checkSerializableAsJson({ name: name, value: value, message: message });
519
+ var orderedValue =
520
+ // TODO: Fix error "Type instantiation is excessively deep and possibly infinite."
521
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
522
+ // @ts-ignore
523
+ order === undefined
524
+ ? deepClone(value)
525
+ : orderJson({
526
+ value: value,
527
+ // <- Note: checkSerializableAsJson asserts that the value is serializable as JSON
528
+ order: order,
529
+ });
530
+ $deepFreeze(orderedValue);
531
+ return orderedValue;
532
+ }
533
+ /**
534
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
535
+ */
536
+
537
+ /**
538
+ * Nonce which is used for replacing things in strings
539
+ *
540
+ * @private within the repository
541
+ */
542
+ var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
543
+ /**
544
+ * The names of the parameters that are reserved for special purposes
545
+ *
546
+ * @public exported from `@promptbook/core`
547
+ */
548
+ exportJson({
549
+ name: 'RESERVED_PARAMETER_NAMES',
550
+ message: "The names of the parameters that are reserved for special purposes",
551
+ value: [
552
+ 'content',
553
+ 'context',
554
+ 'knowledge',
555
+ 'examples',
556
+ 'modelName',
557
+ 'currentDate',
558
+ // <- TODO: list here all command names
559
+ // <- TODO: Add more like 'date', 'modelName',...
560
+ // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
561
+ ],
562
+ });
563
+ /**
564
+ * Note: [💞] Ignore a discrepancy between file name and entity name
565
+ */
566
+
567
+ // <- TODO: !!!!!!! Auto convert to type `import { ... } from 'type-fest';`
568
+ /**
569
+ * Tests if the value is [🚉] serializable as JSON
570
+ *
571
+ * - Almost all primitives are serializable BUT:
572
+ * - `undefined` is not serializable
573
+ * - `NaN` is not serializable
574
+ * - Objects and arrays are serializable if all their properties are serializable
575
+ * - Functions are not serializable
576
+ * - Circular references are not serializable
577
+ * - `Date` objects are not serializable
578
+ * - `Map` and `Set` objects are not serializable
579
+ * - `RegExp` objects are not serializable
580
+ * - `Error` objects are not serializable
581
+ * - `Symbol` objects are not serializable
582
+ * - And much more...
583
+ *
584
+ *
585
+ * @public exported from `@promptbook/utils`
586
+ */
587
+ function isSerializableAsJson(value) {
588
+ try {
589
+ checkSerializableAsJson({ value: value });
590
+ return true;
591
+ }
592
+ catch (error) {
593
+ return false;
594
+ }
595
+ }
596
+ /**
597
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
598
+ * TODO: [🧠][💺] Can be done this on type-level?
599
+ */
600
+
601
+ /**
602
+ * Stringify the PipelineJson with proper formatting
603
+ *
604
+ * Note: [0] It can be used for more JSON types like whole collection of pipelines, single knowledge piece, etc.
605
+ * Note: In contrast to JSON.stringify, this function ensures that **embedding index** is on single line
606
+ *
607
+ * @public exported from `@promptbook/editable`
608
+ */
609
+ function stringifyPipelineJson(pipeline) {
610
+ if (!isSerializableAsJson(pipeline)) {
611
+ throw new UnexpectedError(spaceTrim("\n Cannot stringify the pipeline, because it is not serializable as JSON\n\n There can be multiple reasons:\n 1) The pipeline contains circular references\n 2) It is not a valid PipelineJson\n "));
612
+ }
613
+ var pipelineJsonStringified = JSON.stringify(pipeline, null, 4);
614
+ for (var i = 0; i < LOOP_LIMIT; i++) {
615
+ pipelineJsonStringified = pipelineJsonStringified.replace(/(-?0\.\d+),[\n\s]+(-?0\.\d+)/gms, "$1".concat(REPLACING_NONCE, "$2"));
616
+ }
617
+ pipelineJsonStringified = pipelineJsonStringified.split(REPLACING_NONCE).join(', ');
618
+ pipelineJsonStringified += '\n';
619
+ return pipelineJsonStringified;
620
+ }
621
+ /**
622
+ * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book.md
623
+ * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
624
+ * TODO: [🧠] Maybe more elegant solution than replacing via regex
625
+ * TODO: [🍙] Make some standard order of json properties
626
+ */
627
+
628
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION, removePipelineCommand, renamePipelineParameter, stringifyPipelineJson };
629
+ //# sourceMappingURL=index.es.js.map