@promptbook/markitdown 0.84.0-10

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 (675) hide show
  1. package/README.md +441 -0
  2. package/esm/index.es.js +6423 -0
  3. package/esm/index.es.js.map +1 -0
  4. package/esm/typings/books/index.d.ts +131 -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 +52 -0
  9. package/esm/typings/src/_packages/core.index.d.ts +252 -0
  10. package/esm/typings/src/_packages/documents.index.d.ts +8 -0
  11. package/esm/typings/src/_packages/editable.index.d.ts +90 -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/markitdown.index.d.ts +8 -0
  18. package/esm/typings/src/_packages/node.index.d.ts +22 -0
  19. package/esm/typings/src/_packages/openai.index.d.ts +20 -0
  20. package/esm/typings/src/_packages/pdf.index.d.ts +14 -0
  21. package/esm/typings/src/_packages/remote-client.index.d.ts +18 -0
  22. package/esm/typings/src/_packages/remote-server.index.d.ts +12 -0
  23. package/esm/typings/src/_packages/templates.index.d.ts +4 -0
  24. package/esm/typings/src/_packages/types.index.d.ts +548 -0
  25. package/esm/typings/src/_packages/utils.index.d.ts +162 -0
  26. package/esm/typings/src/_packages/vercel.index.d.ts +6 -0
  27. package/esm/typings/src/_packages/website-crawler.index.d.ts +8 -0
  28. package/esm/typings/src/_packages/wizzard.index.d.ts +52 -0
  29. package/esm/typings/src/cli/cli-commands/about.d.ts +12 -0
  30. package/esm/typings/src/cli/cli-commands/hello.d.ts +12 -0
  31. package/esm/typings/src/cli/cli-commands/list-models.d.ts +11 -0
  32. package/esm/typings/src/cli/cli-commands/make.d.ts +14 -0
  33. package/esm/typings/src/cli/cli-commands/prettify.d.ts +13 -0
  34. package/esm/typings/src/cli/cli-commands/run.d.ts +15 -0
  35. package/esm/typings/src/cli/cli-commands/runInteractiveChatbot.d.ts +32 -0
  36. package/esm/typings/src/cli/cli-commands/test-command.d.ts +14 -0
  37. package/esm/typings/src/cli/main.d.ts +16 -0
  38. package/esm/typings/src/cli/promptbookCli.d.ts +13 -0
  39. package/esm/typings/src/cli/test/ptbk.d.ts +5 -0
  40. package/esm/typings/src/cli/test/ptbk.test.d.ts +1 -0
  41. package/esm/typings/src/collection/PipelineCollection.d.ts +27 -0
  42. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +37 -0
  43. package/esm/typings/src/collection/collectionToJson.d.ts +13 -0
  44. package/esm/typings/src/collection/collectionToJson.test.d.ts +7 -0
  45. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +65 -0
  46. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.test.d.ts +1 -0
  47. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +13 -0
  48. package/esm/typings/src/collection/constructors/createCollectionFromJson.test.d.ts +1 -0
  49. package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +23 -0
  50. package/esm/typings/src/collection/constructors/createCollectionFromPromise.test.d.ts +1 -0
  51. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +29 -0
  52. package/esm/typings/src/collection/constructors/createSubcollection.d.ts +13 -0
  53. package/esm/typings/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +11 -0
  54. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommand.test.d.ts +1 -0
  55. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts +9 -0
  56. package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts +17 -0
  57. package/esm/typings/src/commands/EXPECT/expectCommand.test.d.ts +1 -0
  58. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +9 -0
  59. package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts +10 -0
  60. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +27 -0
  61. package/esm/typings/src/commands/FOREACH/foreachCommand.test.d.ts +1 -0
  62. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +14 -0
  63. package/esm/typings/src/commands/FORMAT/FormatCommand.d.ts +9 -0
  64. package/esm/typings/src/commands/FORMAT/formatCommand.test.d.ts +1 -0
  65. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +9 -0
  66. package/esm/typings/src/commands/FORMFACTOR/FormfactorCommand.d.ts +11 -0
  67. package/esm/typings/src/commands/FORMFACTOR/formfactorCommand.test.d.ts +1 -0
  68. package/esm/typings/src/commands/FORMFACTOR/formfactorCommandParser.d.ts +11 -0
  69. package/esm/typings/src/commands/JOKER/JokerCommand.d.ts +11 -0
  70. package/esm/typings/src/commands/JOKER/jokerCommand.test.d.ts +1 -0
  71. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +9 -0
  72. package/esm/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +11 -0
  73. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts +1 -0
  74. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +12 -0
  75. package/esm/typings/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.d.ts +11 -0
  76. package/esm/typings/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.test.d.ts +4 -0
  77. package/esm/typings/src/commands/MODEL/ModelCommand.d.ts +14 -0
  78. package/esm/typings/src/commands/MODEL/modelCommand.test.d.ts +1 -0
  79. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +10 -0
  80. package/esm/typings/src/commands/PARAMETER/ParameterCommand.d.ts +15 -0
  81. package/esm/typings/src/commands/PARAMETER/parameterCommand.test.d.ts +1 -0
  82. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +9 -0
  83. package/esm/typings/src/commands/PERSONA/PersonaCommand.d.ts +13 -0
  84. package/esm/typings/src/commands/PERSONA/personaCommand.test.d.ts +1 -0
  85. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +9 -0
  86. package/esm/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts +11 -0
  87. package/esm/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts +1 -0
  88. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +9 -0
  89. package/esm/typings/src/commands/SECTION/SectionCommand.d.ts +11 -0
  90. package/esm/typings/src/commands/SECTION/sectionCommand.test.d.ts +1 -0
  91. package/esm/typings/src/commands/SECTION/sectionCommandParser.d.ts +20 -0
  92. package/esm/typings/src/commands/URL/UrlCommand.d.ts +10 -0
  93. package/esm/typings/src/commands/URL/urlCommand.test.d.ts +1 -0
  94. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +9 -0
  95. package/esm/typings/src/commands/X_ACTION/ActionCommand.d.ts +9 -0
  96. package/esm/typings/src/commands/X_ACTION/actionCommand.test.d.ts +1 -0
  97. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +12 -0
  98. package/esm/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +9 -0
  99. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts +1 -0
  100. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +12 -0
  101. package/esm/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +10 -0
  102. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts +1 -0
  103. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +11 -0
  104. package/esm/typings/src/commands/_common/getParserForCommand.d.ts +11 -0
  105. package/esm/typings/src/commands/_common/getParserForCommand.test.d.ts +1 -0
  106. package/esm/typings/src/commands/_common/parseCommand.d.ts +12 -0
  107. package/esm/typings/src/commands/_common/parseCommand.test.d.ts +1 -0
  108. package/esm/typings/src/commands/_common/stringifyCommand.d.ts +12 -0
  109. package/esm/typings/src/commands/_common/stringifyCommand.test.d.ts +1 -0
  110. package/esm/typings/src/commands/_common/types/Command.d.ts +6 -0
  111. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +197 -0
  112. package/esm/typings/src/commands/_common/types/CommandType.d.ts +17 -0
  113. package/esm/typings/src/commands/_common/types/CommandUsagePlaces.d.ts +13 -0
  114. package/esm/typings/src/commands/index.d.ts +9 -0
  115. package/esm/typings/src/config.d.ts +259 -0
  116. package/esm/typings/src/config.test.d.ts +4 -0
  117. package/esm/typings/src/constants.d.ts +35 -0
  118. package/esm/typings/src/conversion/compilePipeline.d.ts +25 -0
  119. package/esm/typings/src/conversion/compilePipeline.test.d.ts +1 -0
  120. package/esm/typings/src/conversion/compilePipelineOnRemoteServer.d.ts +21 -0
  121. package/esm/typings/src/conversion/parsePipeline.d.ts +30 -0
  122. package/esm/typings/src/conversion/parsePipeline.test.d.ts +1 -0
  123. package/esm/typings/src/conversion/pipelineJsonToString.d.ts +18 -0
  124. package/esm/typings/src/conversion/prettify/PrettifyOptions.d.ts +13 -0
  125. package/esm/typings/src/conversion/prettify/prettifyPipelineString.d.ts +12 -0
  126. package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +30 -0
  127. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.d.ts +15 -0
  128. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.test.d.ts +1 -0
  129. package/esm/typings/src/conversion/utils/extractVariablesFromScript.d.ts +14 -0
  130. package/esm/typings/src/conversion/utils/extractVariablesFromScript.test.d.ts +1 -0
  131. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +30 -0
  132. package/esm/typings/src/conversion/validation/pipelineStringToJson-parseErrors.test.d.ts +4 -0
  133. package/esm/typings/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +4 -0
  134. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +42 -0
  135. package/esm/typings/src/conversion/validation/validatePipeline.test.d.ts +4 -0
  136. package/esm/typings/src/dialogs/callback/CallbackInterfaceTools.d.ts +17 -0
  137. package/esm/typings/src/dialogs/callback/CallbackInterfaceToolsOptions.d.ts +14 -0
  138. package/esm/typings/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +22 -0
  139. package/esm/typings/src/dialogs/user-interface-execution-tools.test.d.ts +1 -0
  140. package/esm/typings/src/errors/0-BoilerplateError.d.ts +12 -0
  141. package/esm/typings/src/errors/0-index.d.ts +85 -0
  142. package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
  143. package/esm/typings/src/errors/CollectionError.d.ts +9 -0
  144. package/esm/typings/src/errors/EnvironmentMismatchError.d.ts +9 -0
  145. package/esm/typings/src/errors/ExpectError.d.ts +12 -0
  146. package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
  147. package/esm/typings/src/errors/LimitReachedError.d.ts +9 -0
  148. package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
  149. package/esm/typings/src/errors/NotFoundError.d.ts +9 -0
  150. package/esm/typings/src/errors/NotYetImplementedError.d.ts +9 -0
  151. package/esm/typings/src/errors/ParseError.d.ts +12 -0
  152. package/esm/typings/src/errors/PipelineExecutionError.d.ts +9 -0
  153. package/esm/typings/src/errors/PipelineLogicError.d.ts +9 -0
  154. package/esm/typings/src/errors/PipelineUrlError.d.ts +9 -0
  155. package/esm/typings/src/errors/UnexpectedError.d.ts +9 -0
  156. package/esm/typings/src/errors/utils/ErrorJson.d.ts +20 -0
  157. package/esm/typings/src/errors/utils/deserializeError.d.ts +7 -0
  158. package/esm/typings/src/errors/utils/deserializeError.test.d.ts +1 -0
  159. package/esm/typings/src/errors/utils/getErrorReportUrl.d.ts +6 -0
  160. package/esm/typings/src/errors/utils/serializeError.d.ts +7 -0
  161. package/esm/typings/src/errors/utils/serializeError.test.d.ts +1 -0
  162. package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +12 -0
  163. package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +11 -0
  164. package/esm/typings/src/executables/apps/locateLibreoffice.test.d.ts +1 -0
  165. package/esm/typings/src/executables/apps/locatePandoc.d.ts +11 -0
  166. package/esm/typings/src/executables/apps/locatePandoc.test.d.ts +1 -0
  167. package/esm/typings/src/executables/locateApp.d.ts +33 -0
  168. package/esm/typings/src/executables/locateApp.test.d.ts +1 -0
  169. package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +12 -0
  170. package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +12 -0
  171. package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +12 -0
  172. package/esm/typings/src/execution/AvailableModel.d.ts +38 -0
  173. package/esm/typings/src/execution/CommonToolsOptions.d.ts +24 -0
  174. package/esm/typings/src/execution/EmbeddingVector.d.ts +8 -0
  175. package/esm/typings/src/execution/Executables.d.ts +18 -0
  176. package/esm/typings/src/execution/ExecutionTools.d.ts +69 -0
  177. package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
  178. package/esm/typings/src/execution/LlmExecutionTools.d.ts +61 -0
  179. package/esm/typings/src/execution/LlmExecutionToolsConstructor.d.ts +10 -0
  180. package/esm/typings/src/execution/PipelineExecutor.d.ts +19 -0
  181. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +50 -0
  182. package/esm/typings/src/execution/PromptResult.d.ts +101 -0
  183. package/esm/typings/src/execution/PromptResultUsage.d.ts +33 -0
  184. package/esm/typings/src/execution/PromptbookFetch.d.ts +5 -0
  185. package/esm/typings/src/execution/PromptbookFetch.test-type.d.ts +5 -0
  186. package/esm/typings/src/execution/ScriptExecutionTools.d.ts +39 -0
  187. package/esm/typings/src/execution/UncertainNumber.d.ts +19 -0
  188. package/esm/typings/src/execution/UserInterfaceTools.d.ts +46 -0
  189. package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +13 -0
  190. package/esm/typings/src/execution/createPipelineExecutor/$OngoingTaskResult.d.ts +45 -0
  191. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +46 -0
  192. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +13 -0
  193. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +49 -0
  194. package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts +51 -0
  195. package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +15 -0
  196. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +64 -0
  197. package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +34 -0
  198. package/esm/typings/src/execution/createPipelineExecutor/getContextForTask.d.ts +10 -0
  199. package/esm/typings/src/execution/createPipelineExecutor/getExamplesForTask.d.ts +10 -0
  200. package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +27 -0
  201. package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts +30 -0
  202. package/esm/typings/src/execution/embeddingVectorToString.d.ts +7 -0
  203. package/esm/typings/src/execution/execution-report/ExecutionPromptReportJson.d.ts +24 -0
  204. package/esm/typings/src/execution/execution-report/ExecutionReportJson.d.ts +41 -0
  205. package/esm/typings/src/execution/execution-report/ExecutionReportString.d.ts +16 -0
  206. package/esm/typings/src/execution/execution-report/ExecutionReportStringOptions.d.ts +25 -0
  207. package/esm/typings/src/execution/execution-report/countWorkingDuration.d.ts +7 -0
  208. package/esm/typings/src/execution/execution-report/countWorkingDuration.test.d.ts +1 -0
  209. package/esm/typings/src/execution/execution-report/executionReportJsonToString.d.ts +15 -0
  210. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +7 -0
  211. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +11 -0
  212. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +8 -0
  213. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +22 -0
  214. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +7 -0
  215. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +8 -0
  216. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts +1 -0
  217. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +12 -0
  218. package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
  219. package/esm/typings/src/execution/utils/addUsage.d.ts +9 -0
  220. package/esm/typings/src/execution/utils/addUsage.test.d.ts +1 -0
  221. package/esm/typings/src/execution/utils/checkExpectations.d.ts +29 -0
  222. package/esm/typings/src/execution/utils/checkExpectations.test.d.ts +1 -0
  223. package/esm/typings/src/execution/utils/computeUsageCounts.d.ts +10 -0
  224. package/esm/typings/src/execution/utils/forEachAsync.d.ts +20 -0
  225. package/esm/typings/src/execution/utils/uncertainNumber.d.ts +9 -0
  226. package/esm/typings/src/execution/utils/usage-constants.d.ts +130 -0
  227. package/esm/typings/src/execution/utils/usageToHuman.d.ts +16 -0
  228. package/esm/typings/src/execution/utils/usageToWorktime.d.ts +12 -0
  229. package/esm/typings/src/execution/utils/usageToWorktime.test.d.ts +1 -0
  230. package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts +10 -0
  231. package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts +10 -0
  232. package/esm/typings/src/formats/_common/FormatDefinition.d.ts +70 -0
  233. package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +31 -0
  234. package/esm/typings/src/formats/csv/CsvFormatDefinition.d.ts +17 -0
  235. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  236. package/esm/typings/src/formats/csv/CsvSettings.d.ts +13 -0
  237. package/esm/typings/src/formats/index.d.ts +9 -0
  238. package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts +19 -0
  239. package/esm/typings/src/formats/json/utils/isValidJsonString.d.ts +6 -0
  240. package/esm/typings/src/formats/json/utils/isValidJsonString.test.d.ts +1 -0
  241. package/esm/typings/src/formats/text/TextFormatDefinition.d.ts +19 -0
  242. package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts +19 -0
  243. package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts +14 -0
  244. package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +40 -0
  245. package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts +8 -0
  246. package/esm/typings/src/formfactors/_common/string_formfactor_name.d.ts +5 -0
  247. package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts +45 -0
  248. package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts +24 -0
  249. package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts +14 -0
  250. package/esm/typings/src/formfactors/image-generator/ImageGeneratorFormfactorDefinition.d.ts +24 -0
  251. package/esm/typings/src/formfactors/index.d.ts +145 -0
  252. package/esm/typings/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts +19 -0
  253. package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts +25 -0
  254. package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts +24 -0
  255. package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +20 -0
  256. package/esm/typings/src/high-level-abstractions/implicit-formfactor/ImplicitFormfactorHla.d.ts +10 -0
  257. package/esm/typings/src/high-level-abstractions/index.d.ts +54 -0
  258. package/esm/typings/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts +13 -0
  259. package/esm/typings/src/llm-providers/_common/register/$llmToolsMetadataRegister.d.ts +13 -0
  260. package/esm/typings/src/llm-providers/_common/register/$llmToolsRegister.d.ts +13 -0
  261. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +25 -0
  262. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +24 -0
  263. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizzardOrCli.d.ts +15 -0
  264. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +27 -0
  265. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +13 -0
  266. package/esm/typings/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +23 -0
  267. package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +36 -0
  268. package/esm/typings/src/llm-providers/_common/register/LlmToolsOptions.d.ts +10 -0
  269. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +40 -0
  270. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.test.d.ts +1 -0
  271. package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts +28 -0
  272. package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +19 -0
  273. package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts +19 -0
  274. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +15 -0
  275. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/countTotalUsage.d.ts +17 -0
  276. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +36 -0
  277. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +60 -0
  278. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +31 -0
  279. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +24 -0
  280. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts +18 -0
  281. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.test.d.ts +4 -0
  282. package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +19 -0
  283. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +7 -0
  284. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +14 -0
  285. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +16 -0
  286. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +63 -0
  287. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +37 -0
  288. package/esm/typings/src/llm-providers/azure-openai/createAzureOpenAiExecutionTools.d.ts +15 -0
  289. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +6 -0
  290. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +14 -0
  291. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +15 -0
  292. package/esm/typings/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts +9 -0
  293. package/esm/typings/src/llm-providers/google/createGoogleExecutionTools.d.ts +14 -0
  294. package/esm/typings/src/llm-providers/google/register-configuration.d.ts +14 -0
  295. package/esm/typings/src/llm-providers/google/register-constructor.d.ts +15 -0
  296. package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +15 -0
  297. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +40 -0
  298. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +44 -0
  299. package/esm/typings/src/llm-providers/mocked/test/fakeTextToExpectations.test.d.ts +1 -0
  300. package/esm/typings/src/llm-providers/mocked/test/faked-completion.test.d.ts +1 -0
  301. package/esm/typings/src/llm-providers/mocked/test/joker.test.d.ts +4 -0
  302. package/esm/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts +5 -0
  303. package/esm/typings/src/llm-providers/mocked/test/mocked-completion.test.d.ts +4 -0
  304. package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +63 -0
  305. package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +21 -0
  306. package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts +5 -0
  307. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +36 -0
  308. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +14 -0
  309. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +84 -0
  310. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +11 -0
  311. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.d.ts +18 -0
  312. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.test.d.ts +4 -0
  313. package/esm/typings/src/llm-providers/openai/computeUsage.d.ts +16 -0
  314. package/esm/typings/src/llm-providers/openai/computeUsage.test.d.ts +1 -0
  315. package/esm/typings/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +15 -0
  316. package/esm/typings/src/llm-providers/openai/createOpenAiExecutionTools.d.ts +15 -0
  317. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +31 -0
  318. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +6 -0
  319. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +24 -0
  320. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +25 -0
  321. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +59 -0
  322. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +5 -0
  323. package/esm/typings/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts +23 -0
  324. package/esm/typings/src/llm-providers/vercel/VercelProvider.d.ts +13 -0
  325. package/esm/typings/src/llm-providers/vercel/createExecutionToolsFromVercelProvider.d.ts +8 -0
  326. package/esm/typings/src/llm-providers/vercel/playground/playground.d.ts +6 -0
  327. package/esm/typings/src/other/templates/getBookTemplates.d.ts +24 -0
  328. package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts +10 -0
  329. package/esm/typings/src/personas/preparePersona.d.ts +17 -0
  330. package/esm/typings/src/pipeline/PipelineInterface/PipelineInterface.d.ts +22 -0
  331. package/esm/typings/src/pipeline/PipelineInterface/constants.d.ts +14 -0
  332. package/esm/typings/src/pipeline/PipelineInterface/getPipelineInterface.d.ts +11 -0
  333. package/esm/typings/src/pipeline/PipelineInterface/isPipelineImplementingInterface.d.ts +26 -0
  334. package/esm/typings/src/pipeline/PipelineInterface/isPipelineInterfacesEqual.d.ts +10 -0
  335. package/esm/typings/src/pipeline/PipelineJson/CommonTaskJson.d.ts +100 -0
  336. package/esm/typings/src/pipeline/PipelineJson/DialogTaskJson.d.ts +13 -0
  337. package/esm/typings/src/pipeline/PipelineJson/Expectations.d.ts +40 -0
  338. package/esm/typings/src/pipeline/PipelineJson/KnowledgePieceJson.d.ts +73 -0
  339. package/esm/typings/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts +44 -0
  340. package/esm/typings/src/pipeline/PipelineJson/ParameterJson.d.ts +98 -0
  341. package/esm/typings/src/pipeline/PipelineJson/PersonaJson.d.ts +45 -0
  342. package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts +112 -0
  343. package/esm/typings/src/pipeline/PipelineJson/PreparationJson.d.ts +22 -0
  344. package/esm/typings/src/pipeline/PipelineJson/PromptTaskJson.d.ts +26 -0
  345. package/esm/typings/src/pipeline/PipelineJson/ScriptTaskJson.d.ts +20 -0
  346. package/esm/typings/src/pipeline/PipelineJson/SimpleTaskJson.d.ts +13 -0
  347. package/esm/typings/src/pipeline/PipelineJson/TaskJson.d.ts +11 -0
  348. package/esm/typings/src/pipeline/PipelineString.d.ts +9 -0
  349. package/esm/typings/src/pipeline/book-notation.d.ts +18 -0
  350. package/esm/typings/src/pipeline/isValidPipelineString.d.ts +13 -0
  351. package/esm/typings/src/pipeline/isValidPipelineString.test.d.ts +4 -0
  352. package/esm/typings/src/pipeline/prompt-notation.d.ts +18 -0
  353. package/esm/typings/src/pipeline/prompt-notation.test.d.ts +4 -0
  354. package/esm/typings/src/pipeline/validatePipelineString.d.ts +14 -0
  355. package/esm/typings/src/postprocessing/utils/extractBlock.d.ts +16 -0
  356. package/esm/typings/src/postprocessing/utils/extractJsonBlock.d.ts +25 -0
  357. package/esm/typings/src/postprocessing/utils/extractJsonBlock.test.d.ts +1 -0
  358. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +51 -0
  359. package/esm/typings/src/prepare/isPipelinePrepared.d.ts +18 -0
  360. package/esm/typings/src/prepare/isPipelinePrepared.test.d.ts +1 -0
  361. package/esm/typings/src/prepare/preparePipeline.d.ts +22 -0
  362. package/esm/typings/src/prepare/preparePipelineOnRemoteServer.d.ts +17 -0
  363. package/esm/typings/src/prepare/prepareTasks.d.ts +33 -0
  364. package/esm/typings/src/prepare/unpreparePipeline.d.ts +13 -0
  365. package/esm/typings/src/remote-server/createRemoteClient.d.ts +10 -0
  366. package/esm/typings/src/remote-server/socket-types/_common/PromptbookServer_Error.d.ts +7 -0
  367. package/esm/typings/src/remote-server/socket-types/_common/PromptbookServer_Progress.d.ts +10 -0
  368. package/esm/typings/src/remote-server/socket-types/_subtypes/PromptbookServer_Identification.d.ts +49 -0
  369. package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts +17 -0
  370. package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Response.d.ts +17 -0
  371. package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Request.d.ts +17 -0
  372. package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Response.d.ts +12 -0
  373. package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Request.d.ts +17 -0
  374. package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Response.d.ts +12 -0
  375. package/esm/typings/src/remote-server/startRemoteServer.d.ts +24 -0
  376. package/esm/typings/src/remote-server/types/RemoteClientOptions.d.ts +32 -0
  377. package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts +73 -0
  378. package/esm/typings/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +43 -0
  379. package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +20 -0
  380. package/esm/typings/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +5 -0
  381. package/esm/typings/src/scrapers/_boilerplate/register-constructor.d.ts +15 -0
  382. package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts +28 -0
  383. package/esm/typings/src/scrapers/_common/Converter.d.ts +23 -0
  384. package/esm/typings/src/scrapers/_common/Scraper.d.ts +59 -0
  385. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +14 -0
  386. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts +19 -0
  387. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.test.d.ts +1 -0
  388. package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +11 -0
  389. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +12 -0
  390. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +15 -0
  391. package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +13 -0
  392. package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
  393. package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +13 -0
  394. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +43 -0
  395. package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +12 -0
  396. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +34 -0
  397. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  398. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +11 -0
  399. package/esm/typings/src/scrapers/_common/utils/scraperFetch.d.ts +10 -0
  400. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
  401. package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
  402. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
  403. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  404. package/esm/typings/src/scrapers/document/register-constructor.d.ts +15 -0
  405. package/esm/typings/src/scrapers/document/register-metadata.d.ts +28 -0
  406. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
  407. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
  408. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +20 -0
  409. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  410. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +15 -0
  411. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +28 -0
  412. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
  413. package/esm/typings/src/scrapers/markdown/MarkdownScraper.test.d.ts +4 -0
  414. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
  415. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  416. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +15 -0
  417. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +28 -0
  418. package/esm/typings/src/scrapers/markitdown/MarkitdownScraper.d.ts +50 -0
  419. package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts +22 -0
  420. package/esm/typings/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +5 -0
  421. package/esm/typings/src/scrapers/markitdown/register-constructor.d.ts +17 -0
  422. package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts +28 -0
  423. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +41 -0
  424. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +20 -0
  425. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  426. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +15 -0
  427. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +28 -0
  428. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +50 -0
  429. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +22 -0
  430. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  431. package/esm/typings/src/scrapers/website/register-constructor.d.ts +15 -0
  432. package/esm/typings/src/scrapers/website/register-metadata.d.ts +28 -0
  433. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.d.ts +7 -0
  434. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.test.d.ts +1 -0
  435. package/esm/typings/src/scripting/_test/custom-function-async.test.ts.test.d.ts +1 -0
  436. package/esm/typings/src/scripting/_test/custom-function-missing.test.d.ts +1 -0
  437. package/esm/typings/src/scripting/_test/custom-function-with-dependencies.test.d.ts +1 -0
  438. package/esm/typings/src/scripting/_test/custom-function.test.d.ts +1 -0
  439. package/esm/typings/src/scripting/_test/postprocessing.test.d.ts +1 -0
  440. package/esm/typings/src/scripting/_test/script-execution-errors.test.d.ts +1 -0
  441. package/esm/typings/src/scripting/_test/script-execution-tools.test.d.ts +1 -0
  442. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +22 -0
  443. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -0
  444. package/esm/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts +8 -0
  445. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +26 -0
  446. package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts +52 -0
  447. package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +14 -0
  448. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +18 -0
  449. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +18 -0
  450. package/esm/typings/src/storage/_common/PromptbookStorage.d.ts +24 -0
  451. package/esm/typings/src/storage/_common/PromptbookStorage.test-type.d.ts +5 -0
  452. package/esm/typings/src/storage/blackhole/BlackholeStorage.d.ts +33 -0
  453. package/esm/typings/src/storage/file-cache-storage/FileCacheStorage.d.ts +33 -0
  454. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +10 -0
  455. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts +7 -0
  456. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts +1 -0
  457. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +10 -0
  458. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +10 -0
  459. package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts +11 -0
  460. package/esm/typings/src/storage/memory/MemoryStorage.d.ts +33 -0
  461. package/esm/typings/src/storage/utils/PrefixStorage.d.ts +25 -0
  462. package/esm/typings/src/types/Arrayable.d.ts +11 -0
  463. package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +7 -0
  464. package/esm/typings/src/types/ModelRequirements.d.ts +104 -0
  465. package/esm/typings/src/types/ModelVariant.d.ts +15 -0
  466. package/esm/typings/src/types/NonEmptyArray.d.ts +8 -0
  467. package/esm/typings/src/types/Prompt.d.ts +111 -0
  468. package/esm/typings/src/types/ScriptLanguage.d.ts +13 -0
  469. package/esm/typings/src/types/SectionType.d.ts +21 -0
  470. package/esm/typings/src/types/TaskProgress.d.ts +43 -0
  471. package/esm/typings/src/types/TaskType.d.ts +15 -0
  472. package/esm/typings/src/types/typeAliasEmoji.d.ts +12 -0
  473. package/esm/typings/src/types/typeAliases.d.ts +636 -0
  474. package/esm/typings/src/utils/$Register.d.ts +39 -0
  475. package/esm/typings/src/utils/$getCurrentDate.d.ts +10 -0
  476. package/esm/typings/src/utils/FromtoItems.d.ts +19 -0
  477. package/esm/typings/src/utils/arrayableToArray.d.ts +11 -0
  478. package/esm/typings/src/utils/arrayableToArray.test.d.ts +1 -0
  479. package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts +17 -0
  480. package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.test.d.ts +1 -0
  481. package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts +10 -0
  482. package/esm/typings/src/utils/editable/edit-pipeline-string/removePipelineCommand.d.ts +22 -0
  483. package/esm/typings/src/utils/editable/edit-pipeline-string/removePipelineCommand.test.d.ts +1 -0
  484. package/esm/typings/src/utils/editable/types/PipelineEditableSerialized.d.ts +27 -0
  485. package/esm/typings/src/utils/editable/utils/isFlatPipeline.d.ts +7 -0
  486. package/esm/typings/src/utils/editable/utils/renamePipelineParameter.d.ts +29 -0
  487. package/esm/typings/src/utils/editable/utils/renamePipelineParameter.test.d.ts +1 -0
  488. package/esm/typings/src/utils/editable/utils/stringifyPipelineJson.d.ts +16 -0
  489. package/esm/typings/src/utils/editable/utils/stringifyPipelineJson.test.d.ts +1 -0
  490. package/esm/typings/src/utils/emojis.d.ts +24 -0
  491. package/esm/typings/src/utils/environment/$getGlobalScope.d.ts +9 -0
  492. package/esm/typings/src/utils/environment/$isRunningInBrowser.d.ts +8 -0
  493. package/esm/typings/src/utils/environment/$isRunningInJest.d.ts +8 -0
  494. package/esm/typings/src/utils/environment/$isRunningInNode.d.ts +8 -0
  495. package/esm/typings/src/utils/environment/$isRunningInWebWorker.d.ts +8 -0
  496. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +16 -0
  497. package/esm/typings/src/utils/execCommand/$execCommandNormalizeOptions.d.ts +12 -0
  498. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +18 -0
  499. package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts +45 -0
  500. package/esm/typings/src/utils/execCommand/execCommand.test.d.ts +1 -0
  501. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts +1 -0
  502. package/esm/typings/src/utils/expectation-counters/constants.d.ts +16 -0
  503. package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts +7 -0
  504. package/esm/typings/src/utils/expectation-counters/countCharacters.test.d.ts +1 -0
  505. package/esm/typings/src/utils/expectation-counters/countLines.d.ts +9 -0
  506. package/esm/typings/src/utils/expectation-counters/countLines.test.d.ts +1 -0
  507. package/esm/typings/src/utils/expectation-counters/countPages.d.ts +9 -0
  508. package/esm/typings/src/utils/expectation-counters/countPages.test.d.ts +1 -0
  509. package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts +7 -0
  510. package/esm/typings/src/utils/expectation-counters/countParagraphs.test.d.ts +1 -0
  511. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +13 -0
  512. package/esm/typings/src/utils/expectation-counters/countSentences.test.d.ts +1 -0
  513. package/esm/typings/src/utils/expectation-counters/countWords.d.ts +7 -0
  514. package/esm/typings/src/utils/expectation-counters/countWords.test.d.ts +1 -0
  515. package/esm/typings/src/utils/expectation-counters/index.d.ts +12 -0
  516. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  517. package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts +1 -0
  518. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  519. package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
  520. package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
  521. package/esm/typings/src/utils/files/isDirectoryExisting.test.d.ts +1 -0
  522. package/esm/typings/src/utils/files/isExecutable.d.ts +11 -0
  523. package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
  524. package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
  525. package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
  526. package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
  527. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +14 -0
  528. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.test.d.ts +1 -0
  529. package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts +38 -0
  530. package/esm/typings/src/utils/markdown/createMarkdownChart.test.d.ts +1 -0
  531. package/esm/typings/src/utils/markdown/createMarkdownTable.d.ts +11 -0
  532. package/esm/typings/src/utils/markdown/createMarkdownTable.test.d.ts +1 -0
  533. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.d.ts +11 -0
  534. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.test.d.ts +1 -0
  535. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts +1 -0
  536. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +36 -0
  537. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts +1 -0
  538. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +15 -0
  539. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts +1 -0
  540. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +22 -0
  541. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.test.d.ts +1 -0
  542. package/esm/typings/src/utils/markdown/flattenMarkdown.d.ts +17 -0
  543. package/esm/typings/src/utils/markdown/flattenMarkdown.test.d.ts +1 -0
  544. package/esm/typings/src/utils/markdown/parseMarkdownSection.d.ts +34 -0
  545. package/esm/typings/src/utils/markdown/parseMarkdownSection.test.d.ts +1 -0
  546. package/esm/typings/src/utils/markdown/prettifyMarkdown.d.ts +9 -0
  547. package/esm/typings/src/utils/markdown/prettifyMarkdown.test.d.ts +1 -0
  548. package/esm/typings/src/utils/markdown/removeMarkdownComments.d.ts +10 -0
  549. package/esm/typings/src/utils/markdown/removeMarkdownComments.test.d.ts +1 -0
  550. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.d.ts +9 -0
  551. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.test.d.ts +1 -0
  552. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +15 -0
  553. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts +1 -0
  554. package/esm/typings/src/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts +12 -0
  555. package/esm/typings/src/utils/normalization/IKeywords.d.ts +21 -0
  556. package/esm/typings/src/utils/normalization/capitalize.d.ts +6 -0
  557. package/esm/typings/src/utils/normalization/capitalize.test.d.ts +1 -0
  558. package/esm/typings/src/utils/normalization/decapitalize.d.ts +6 -0
  559. package/esm/typings/src/utils/normalization/decapitalize.test.d.ts +1 -0
  560. package/esm/typings/src/utils/normalization/isValidKeyword.d.ts +10 -0
  561. package/esm/typings/src/utils/normalization/isValidKeyword.test.d.ts +1 -0
  562. package/esm/typings/src/utils/normalization/nameToUriPart.d.ts +9 -0
  563. package/esm/typings/src/utils/normalization/nameToUriPart.test.d.ts +1 -0
  564. package/esm/typings/src/utils/normalization/nameToUriParts.d.ts +9 -0
  565. package/esm/typings/src/utils/normalization/nameToUriParts.test.d.ts +1 -0
  566. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts +21 -0
  567. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.test.d.ts +1 -0
  568. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts +17 -0
  569. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.test.d.ts +1 -0
  570. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +26 -0
  571. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts +1 -0
  572. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.d.ts +22 -0
  573. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.test.d.ts +1 -0
  574. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts +17 -0
  575. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.test.d.ts +1 -0
  576. package/esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts +6 -0
  577. package/esm/typings/src/utils/normalization/normalizeWhitespaces.test.d.ts +1 -0
  578. package/esm/typings/src/utils/normalization/orderJson.d.ts +21 -0
  579. package/esm/typings/src/utils/normalization/orderJson.test.d.ts +4 -0
  580. package/esm/typings/src/utils/normalization/parseKeywords.d.ts +16 -0
  581. package/esm/typings/src/utils/normalization/parseKeywords.test.d.ts +1 -0
  582. package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +9 -0
  583. package/esm/typings/src/utils/normalization/parseKeywordsFromString.test.d.ts +1 -0
  584. package/esm/typings/src/utils/normalization/removeDiacritics.d.ts +11 -0
  585. package/esm/typings/src/utils/normalization/removeDiacritics.test.d.ts +1 -0
  586. package/esm/typings/src/utils/normalization/searchKeywords.d.ts +10 -0
  587. package/esm/typings/src/utils/normalization/searchKeywords.test.d.ts +1 -0
  588. package/esm/typings/src/utils/normalization/titleToName.d.ts +9 -0
  589. package/esm/typings/src/utils/normalization/titleToName.test.d.ts +1 -0
  590. package/esm/typings/src/utils/organization/$sideEffect.d.ts +9 -0
  591. package/esm/typings/src/utils/organization/TODO_USE.d.ts +12 -0
  592. package/esm/typings/src/utils/organization/TODO_any.d.ts +6 -0
  593. package/esm/typings/src/utils/organization/TODO_object.d.ts +6 -0
  594. package/esm/typings/src/utils/organization/TODO_remove_as.d.ts +6 -0
  595. package/esm/typings/src/utils/organization/TODO_string.d.ts +6 -0
  596. package/esm/typings/src/utils/organization/TODO_unknown.d.ts +6 -0
  597. package/esm/typings/src/utils/organization/___and___.d.ts +7 -0
  598. package/esm/typings/src/utils/organization/___or___.d.ts +6 -0
  599. package/esm/typings/src/utils/organization/empty_object.d.ts +10 -0
  600. package/esm/typings/src/utils/organization/just.d.ts +14 -0
  601. package/esm/typings/src/utils/organization/just_empty_object.d.ts +12 -0
  602. package/esm/typings/src/utils/organization/keepTypeImported.d.ts +9 -0
  603. package/esm/typings/src/utils/organization/keepUnused.d.ts +16 -0
  604. package/esm/typings/src/utils/organization/really_any.d.ts +6 -0
  605. package/esm/typings/src/utils/organization/really_unknown.d.ts +6 -0
  606. package/esm/typings/src/utils/organization/spaceTrim.d.ts +11 -0
  607. package/esm/typings/src/utils/parameters/extractParameterNames.d.ts +10 -0
  608. package/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts +1 -0
  609. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +27 -0
  610. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts +1 -0
  611. package/esm/typings/src/utils/parameters/numberToString.d.ts +7 -0
  612. package/esm/typings/src/utils/parameters/numberToString.test.d.ts +1 -0
  613. package/esm/typings/src/utils/parameters/templateParameters.d.ts +16 -0
  614. package/esm/typings/src/utils/parameters/templateParameters.test.d.ts +1 -0
  615. package/esm/typings/src/utils/parameters/valueToString.d.ts +17 -0
  616. package/esm/typings/src/utils/parameters/valueToString.test.d.ts +1 -0
  617. package/esm/typings/src/utils/parseNumber.d.ts +16 -0
  618. package/esm/typings/src/utils/parseNumber.test.d.ts +1 -0
  619. package/esm/typings/src/utils/random/$randomSeed.d.ts +9 -0
  620. package/esm/typings/src/utils/removeEmojis.d.ts +8 -0
  621. package/esm/typings/src/utils/removeEmojis.test.d.ts +1 -0
  622. package/esm/typings/src/utils/removeQuotes.d.ts +14 -0
  623. package/esm/typings/src/utils/removeQuotes.test.d.ts +1 -0
  624. package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +14 -0
  625. package/esm/typings/src/utils/serialization/asSerializable.d.ts +15 -0
  626. package/esm/typings/src/utils/serialization/asSerializable.test.d.ts +1 -0
  627. package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts +45 -0
  628. package/esm/typings/src/utils/serialization/clonePipeline.d.ts +13 -0
  629. package/esm/typings/src/utils/serialization/deepClone.d.ts +10 -0
  630. package/esm/typings/src/utils/serialization/deepClone.test.d.ts +1 -0
  631. package/esm/typings/src/utils/serialization/exportJson.d.ts +29 -0
  632. package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts +25 -0
  633. package/esm/typings/src/utils/serialization/isSerializableAsJson.test.d.ts +1 -0
  634. package/esm/typings/src/utils/sets/difference.d.ts +10 -0
  635. package/esm/typings/src/utils/sets/difference.test.d.ts +1 -0
  636. package/esm/typings/src/utils/sets/intersection.d.ts +7 -0
  637. package/esm/typings/src/utils/sets/intersection.test.d.ts +1 -0
  638. package/esm/typings/src/utils/sets/union.d.ts +7 -0
  639. package/esm/typings/src/utils/sets/union.test.d.ts +1 -0
  640. package/esm/typings/src/utils/trimCodeBlock.d.ts +9 -0
  641. package/esm/typings/src/utils/trimCodeBlock.test.d.ts +1 -0
  642. package/esm/typings/src/utils/trimEndOfCodeBlock.d.ts +9 -0
  643. package/esm/typings/src/utils/trimEndOfCodeBlock.test.d.ts +1 -0
  644. package/esm/typings/src/utils/unwrapResult.d.ts +37 -0
  645. package/esm/typings/src/utils/unwrapResult.test.d.ts +1 -0
  646. package/esm/typings/src/utils/validators/email/isValidEmail.d.ts +8 -0
  647. package/esm/typings/src/utils/validators/email/isValidEmail.test.d.ts +1 -0
  648. package/esm/typings/src/utils/validators/filePath/isRootPath.d.ts +12 -0
  649. package/esm/typings/src/utils/validators/filePath/isRootPath.test.d.ts +4 -0
  650. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +12 -0
  651. package/esm/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts +1 -0
  652. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +10 -0
  653. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts +1 -0
  654. package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts +10 -0
  655. package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts +1 -0
  656. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +15 -0
  657. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts +1 -0
  658. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts +12 -0
  659. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts +1 -0
  660. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts +11 -0
  661. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts +1 -0
  662. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +13 -0
  663. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts +1 -0
  664. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.d.ts +15 -0
  665. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts +1 -0
  666. package/esm/typings/src/utils/validators/url/isValidUrl.d.ts +13 -0
  667. package/esm/typings/src/utils/validators/url/isValidUrl.test.d.ts +1 -0
  668. package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts +8 -0
  669. package/esm/typings/src/utils/validators/uuid/isValidUuid.test.d.ts +1 -0
  670. package/esm/typings/src/version.d.ts +25 -0
  671. package/esm/typings/src/wizzard/$getCompiledBook.d.ts +16 -0
  672. package/esm/typings/src/wizzard/wizzard.d.ts +63 -0
  673. package/package.json +67 -0
  674. package/umd/index.umd.js +6432 -0
  675. package/umd/index.umd.js.map +1 -0
@@ -0,0 +1,52 @@
1
+ import spaceTrim from 'spacetrim';
2
+ import { extractBlock } from '../../postprocessing/utils/extractBlock';
3
+ import { prettifyMarkdown } from '../../utils/markdown/prettifyMarkdown';
4
+ import { capitalize } from '../../utils/normalization/capitalize';
5
+ import { decapitalize } from '../../utils/normalization/decapitalize';
6
+ import { nameToUriPart } from '../../utils/normalization/nameToUriPart';
7
+ import { nameToUriParts } from '../../utils/normalization/nameToUriParts';
8
+ import { normalizeToKebabCase } from '../../utils/normalization/normalize-to-kebab-case';
9
+ import { normalizeTo_PascalCase } from '../../utils/normalization/normalizeTo_PascalCase';
10
+ import { normalizeTo_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
11
+ import { normalizeTo_camelCase } from '../../utils/normalization/normalizeTo_camelCase';
12
+ import { normalizeTo_snake_case } from '../../utils/normalization/normalizeTo_snake_case';
13
+ import { normalizeWhitespaces } from '../../utils/normalization/normalizeWhitespaces';
14
+ import { removeDiacritics } from '../../utils/normalization/removeDiacritics';
15
+ import { removeEmojis } from '../../utils/removeEmojis';
16
+ import { removeQuotes } from '../../utils/removeQuotes';
17
+ import { trimCodeBlock } from '../../utils/trimCodeBlock';
18
+ import { trimEndOfCodeBlock } from '../../utils/trimEndOfCodeBlock';
19
+ import { unwrapResult } from '../../utils/unwrapResult';
20
+ /**
21
+ * @@@
22
+ *
23
+ * @public exported from `@promptbook/execute-javascript`
24
+ */
25
+ export declare const POSTPROCESSING_FUNCTIONS: {
26
+ spaceTrim: typeof spaceTrim;
27
+ removeQuotes: typeof removeQuotes;
28
+ unwrapResult: typeof unwrapResult;
29
+ trimEndOfCodeBlock: typeof trimEndOfCodeBlock;
30
+ trimCodeBlock: typeof trimCodeBlock;
31
+ trim: (str: string) => string;
32
+ reverse: (str: string) => string;
33
+ removeEmojis: typeof removeEmojis;
34
+ prettifyMarkdown: typeof prettifyMarkdown;
35
+ capitalize: typeof capitalize;
36
+ decapitalize: typeof decapitalize;
37
+ nameToUriPart: typeof nameToUriPart;
38
+ nameToUriParts: typeof nameToUriParts;
39
+ removeDiacritics: typeof removeDiacritics;
40
+ normalizeWhitespaces: typeof normalizeWhitespaces;
41
+ normalizeToKebabCase: typeof normalizeToKebabCase;
42
+ normalizeTo_camelCase: typeof normalizeTo_camelCase;
43
+ normalizeTo_snake_case: typeof normalizeTo_snake_case;
44
+ normalizeTo_PascalCase: typeof normalizeTo_PascalCase;
45
+ parseKeywords: (input: string) => string;
46
+ normalizeTo_SCREAMING_CASE: typeof normalizeTo_SCREAMING_CASE;
47
+ extractBlock: typeof extractBlock;
48
+ };
49
+ /**
50
+ * TODO: DRY [ðŸŊ], [🧠] Where should be POSTPROCESSING_FUNCTIONS located and how it should be named
51
+ * Note: [💞] Ignore a discrepancy between file name and entity name
52
+ */
@@ -0,0 +1,14 @@
1
+ import type { really_any } from '../../../utils/organization/really_any';
2
+ /**
3
+ * Does nothing, but preserves the function in the bundle
4
+ * Compiler is tricked into thinking the function is used
5
+ *
6
+ * @param value any function to preserve
7
+ * @returns nothing
8
+ * @private internal function of `JavascriptExecutionTools` and `JavascriptEvalExecutionTools`
9
+ */
10
+ export declare function preserve(func: (...params: ReadonlyArray<really_any>) => unknown): void;
11
+ /**
12
+ * TODO: Probbably remove in favour of `keepImported`
13
+ * TODO: [1] This maybe does memory leak
14
+ */
@@ -0,0 +1,18 @@
1
+ import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
2
+ import type { ScriptExecutionTools } from '../../execution/ScriptExecutionTools';
3
+ import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptExecutionTools';
4
+ /**
5
+ * ScriptExecutionTools for Python
6
+ *
7
+ * Warning: This is not implemented yet
8
+ *
9
+ * @private still in development
10
+ */
11
+ export declare class PythonExecutionTools implements ScriptExecutionTools {
12
+ protected readonly options: CommonToolsOptions;
13
+ constructor(options?: CommonToolsOptions);
14
+ /**
15
+ * Executes a Python
16
+ */
17
+ execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
18
+ }
@@ -0,0 +1,18 @@
1
+ import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
2
+ import type { ScriptExecutionTools } from '../../execution/ScriptExecutionTools';
3
+ import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptExecutionTools';
4
+ /**
5
+ * ScriptExecutionTools for TypeScript
6
+ *
7
+ * Warning: This is not implemented yet
8
+ *
9
+ * @private still in development
10
+ */
11
+ export declare class TypescriptExecutionTools implements ScriptExecutionTools {
12
+ protected readonly options: CommonToolsOptions;
13
+ constructor(options?: CommonToolsOptions);
14
+ /**
15
+ * Executes a TypeScript
16
+ */
17
+ execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
18
+ }
@@ -0,0 +1,24 @@
1
+ import type { Promisable } from 'type-fest';
2
+ /**
3
+ * Storage of objects with asynchronous API
4
+ *
5
+ * Note: Naming `PromptbookStorage` not `Storage` to avoid name collision with global `Storage` interface.
6
+ * Note: This is simmilar to Web Storage API interface but everything is asynchronous and can store JSON objects.
7
+ */
8
+ export type PromptbookStorage<TItem> = {
9
+ /**
10
+ * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object
11
+ */
12
+ getItem(key: string): Promisable<TItem | null>;
13
+ /**
14
+ * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously
15
+ */
16
+ setItem(key: string, value: TItem): Promisable<void>;
17
+ /**
18
+ * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists
19
+ */
20
+ removeItem(key: string): Promisable<void>;
21
+ };
22
+ /**
23
+ * TODO: [💚] Constrain `TItem` to [🚉] JSON-serializable objects only in type level
24
+ */
@@ -0,0 +1,5 @@
1
+ export {};
2
+ /**
3
+ * Note: [⚩] This should never be in any released package
4
+ * TODO: Is this a good pattern to do type testing?
5
+ */
@@ -0,0 +1,33 @@
1
+ import type { PromptbookStorage } from '../_common/PromptbookStorage';
2
+ /**
3
+ * Behaves like a storage but forgets everything you put in it
4
+ *
5
+ * @public exported from `@promptbook/core`
6
+ */
7
+ export declare class BlackholeStorage<TItem> implements PromptbookStorage<TItem> {
8
+ /**
9
+ * Returns the number of key/value pairs currently present in the list associated with the object.
10
+ */
11
+ get length(): number;
12
+ /**
13
+ * Empties the list associated with the object of all key/value pairs, if there are any.
14
+ */
15
+ clear(): void;
16
+ /**
17
+ * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
18
+ * @param key
19
+ */
20
+ getItem(key: string): null;
21
+ /**
22
+ * Returns the name of the nth key in the list, or null if n is greater than or equal to the number of key/value pairs in the object.
23
+ */
24
+ key(index: number): null;
25
+ /**
26
+ * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
27
+ */
28
+ setItem(key: string, value: TItem): void;
29
+ /**
30
+ * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
31
+ */
32
+ removeItem(key: string): void;
33
+ }
@@ -0,0 +1,33 @@
1
+ import type { ExecutionTools } from '../../execution/ExecutionTools';
2
+ import type { PromptbookStorage } from '../_common/PromptbookStorage';
3
+ import type { FileCacheStorageOptions } from './FileCacheStorageOptions';
4
+ /**
5
+ * @@@
6
+ *
7
+ * @public exported from `@promptbook/node`
8
+ */
9
+ export declare class FileCacheStorage<TItem> implements PromptbookStorage<TItem> {
10
+ protected readonly tools: Required<Pick<ExecutionTools, 'fs'>>;
11
+ private readonly options;
12
+ constructor(tools: Required<Pick<ExecutionTools, 'fs'>>, options: FileCacheStorageOptions);
13
+ /**
14
+ * @@@
15
+ */
16
+ private getFilenameForKey;
17
+ /**
18
+ * @@@ Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
19
+ */
20
+ getItem(key: string): Promise<TItem | null>;
21
+ /**
22
+ * @@@ Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
23
+ */
24
+ setItem(key: string, value: TItem): Promise<void>;
25
+ /**
26
+ * @@@ Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
27
+ */
28
+ removeItem(key: string): Promise<void>;
29
+ }
30
+ /**
31
+ * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
32
+ * Note: [ðŸŸĒ] Code in this file should never be never released in packages that could be imported into browser environment
33
+ */
@@ -0,0 +1,10 @@
1
+ import type { string_dirname } from '../../types/typeAliases';
2
+ /**
3
+ * @@@
4
+ */
5
+ export type FileCacheStorageOptions = {
6
+ /**
7
+ * @@@
8
+ */
9
+ rootFolderPath: string_dirname;
10
+ };
@@ -0,0 +1,7 @@
1
+ import type { string_name } from '../../../types/typeAliases';
2
+ /**
3
+ * @@@
4
+ *
5
+ * @private for `FileCacheStorage`
6
+ */
7
+ export declare function nameToSubfolderPath(name: string_name): ReadonlyArray<string>;
@@ -0,0 +1,10 @@
1
+ import type { PromptbookStorage } from '../_common/PromptbookStorage';
2
+ /**
3
+ * Gets wrapper around `localStorage` object which can be used as `PromptbookStorage`
4
+ *
5
+ * @public exported from `@promptbook/browser`
6
+ */
7
+ export declare function getLocalStorage<TItem>(): PromptbookStorage<TItem>;
8
+ /**
9
+ * Note: [ðŸ”ĩ] Code in this file should never be published outside of `@promptbook/browser`
10
+ */
@@ -0,0 +1,10 @@
1
+ import type { PromptbookStorage } from '../_common/PromptbookStorage';
2
+ /**
3
+ * Gets wrapper around `sessionStorage` object which can be used as `PromptbookStorage`
4
+ *
5
+ * @public exported from `@promptbook/browser`
6
+ */
7
+ export declare function getSessionStorage<TItem>(): PromptbookStorage<TItem>;
8
+ /**
9
+ * Note: [ðŸ”ĩ] Code in this file should never be published outside of `@promptbook/browser`
10
+ */
@@ -0,0 +1,11 @@
1
+ import type { PromptbookStorage } from '../../_common/PromptbookStorage';
2
+ /**
3
+ * @@@
4
+ *
5
+ * @private for `getLocalStorage` and `getSessionStorage`
6
+ */
7
+ export declare function makePromptbookStorageFromWebStorage<TValue>(webStorage: Storage): PromptbookStorage<TValue>;
8
+ /**
9
+ * TODO: [🧠] Should this be named `makePromptbookStorageFromWebStorage` vs `createPromptbookStorageFromWebStorage`
10
+ * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
11
+ */
@@ -0,0 +1,33 @@
1
+ import type { PromptbookStorage } from '../_common/PromptbookStorage';
2
+ /**
3
+ * Stores data in memory (HEAP)
4
+ *
5
+ * @public exported from `@promptbook/core`
6
+ */
7
+ export declare class MemoryStorage<TItem> implements PromptbookStorage<TItem> {
8
+ private storage;
9
+ /**
10
+ * Returns the number of key/value pairs currently present in the list associated with the object.
11
+ */
12
+ get length(): number;
13
+ /**
14
+ * Empties the list associated with the object of all key/value pairs, if there are any.
15
+ */
16
+ clear(): void;
17
+ /**
18
+ * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
19
+ */
20
+ getItem(key: string): TItem | null;
21
+ /**
22
+ * Returns the name of the nth key in the list, or null if n is greater than or equal to the number of key/value pairs in the object.
23
+ */
24
+ key(index: number): string | null;
25
+ /**
26
+ * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
27
+ */
28
+ setItem(key: string, value: TItem): void;
29
+ /**
30
+ * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
31
+ */
32
+ removeItem(key: string): void;
33
+ }
@@ -0,0 +1,25 @@
1
+ import type { Promisable } from 'type-fest';
2
+ import type { PromptbookStorage } from '../_common/PromptbookStorage';
3
+ /**
4
+ * This class behaves like LocalStorage but separates keys by prefix
5
+ *
6
+ * @public exported from `@promptbook/core`
7
+ */
8
+ export declare class PrefixStorage<TItem> implements PromptbookStorage<TItem> {
9
+ private baseStorage;
10
+ private keyPrefix;
11
+ private separator;
12
+ constructor(baseStorage: PromptbookStorage<TItem>, keyPrefix: string, separator?: string);
13
+ /**
14
+ * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
15
+ */
16
+ getItem(key: string): Promisable<TItem | null>;
17
+ /**
18
+ * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
19
+ */
20
+ setItem(key: string, value: TItem): Promisable<void>;
21
+ /**
22
+ * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
23
+ */
24
+ removeItem(key: string): void;
25
+ }
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Item or array of items
3
+ *
4
+ * 1) Any item except array and undefined represents array with that one item (also null)
5
+ * 2) Undefined represents empty array
6
+ * 3) Array represents itself
7
+ *
8
+ * @deprecated Use `Arrayable` from `type-fest` instead
9
+ * @private internal type
10
+ */
11
+ export type Arrayable<TItem> = TItem | ReadonlyArray<TItem> | undefined;
@@ -0,0 +1,7 @@
1
+ /**
2
+ * @@@
3
+ */
4
+ export type IntermediateFilesStrategy = 'HIDE_AND_CLEAN' | 'HIDE_AND_KEEP';
5
+ /**
6
+ * TODO: [🎅] Maube add options for all kinds of cache, unite with `isCacheReloaded` and make `cacheStrategy` (which is not specific only for intermediate files)
7
+ */
@@ -0,0 +1,104 @@
1
+ import type { ModelVariant } from './ModelVariant';
2
+ import type { number_model_temperature } from './typeAliases';
3
+ import type { number_seed } from './typeAliases';
4
+ import type { string_model_name } from './typeAliases';
5
+ import type { string_system_message } from './typeAliases';
6
+ /**
7
+ * Abstract way to specify the LLM.
8
+ * It does not specify the LLM with concrete version itself, only the requirements for the LLM.
9
+ *
10
+ * Note: [🚉] This is fully serializable as JSON
11
+ * @see https://github.com/webgptorg/promptbook#model-requirements
12
+ */
13
+ export type ModelRequirements = CompletionModelRequirements | ChatModelRequirements | EmbeddingModelRequirements;
14
+ /**
15
+ * Model requirements for the completion variant
16
+ *
17
+ * Note: [🚉] This is fully serializable as JSON
18
+ */
19
+ export type CompletionModelRequirements = CommonModelRequirements & {
20
+ /**
21
+ * Completion model variant
22
+ */
23
+ modelVariant: 'COMPLETION';
24
+ };
25
+ /**
26
+ * Model requirements for the chat variant
27
+ *
28
+ * Note: [🚉] This is fully serializable as JSON
29
+ */
30
+ export type ChatModelRequirements = CommonModelRequirements & {
31
+ /**
32
+ * Chat model variant
33
+ */
34
+ modelVariant: 'CHAT';
35
+ /**
36
+ * System message to be used in the model
37
+ */
38
+ readonly systemMessage?: string_system_message;
39
+ };
40
+ /**
41
+ * Model requirements for the embedding variant
42
+ *
43
+ * Note: [🚉] This is fully serializable as JSON
44
+ */
45
+ export type EmbeddingModelRequirements = CommonModelRequirements & {
46
+ /**
47
+ * Embedding model variant
48
+ */
49
+ modelVariant: 'EMBEDDING';
50
+ };
51
+ /**
52
+ * Common properties for all model requirements variants
53
+ *
54
+ * Note: [🚉] This is fully serializable as JSON
55
+ *
56
+ * @private just abstract the common properties of the model requirements
57
+ */
58
+ export type CommonModelRequirements = {
59
+ /**
60
+ * Model variant describes the very general type of the model
61
+ *
62
+ * There are 3 variants:
63
+ * - **COMPLETION** - model that takes prompt and writes the rest of the text
64
+ * - **CHAT** - model that takes prompt and previous messages and returns response
65
+ * - **EMBEDDING** - model that takes prompt and returns embedding
66
+ * <- [ðŸĪ–]
67
+ */
68
+ readonly modelVariant: ModelVariant;
69
+ /**
70
+ * The model for text prompt
71
+ *
72
+ * Note: Model must be compatible with the model variant
73
+ * Note: If not specified, the best model for the variant will be used
74
+ *
75
+ * @example 'gpt-4', 'gpt-4-32k-0314', 'gpt-3.5-turbo-instruct',...
76
+ */
77
+ readonly modelName?: string_model_name;
78
+ /**
79
+ * The temperature of the model
80
+ *
81
+ * Note: [ðŸ’ą] Promptbook is using just `temperature` (not `top_k` and `top_p`)
82
+ */
83
+ readonly temperature?: number_model_temperature;
84
+ /**
85
+ * Seed for the model
86
+ */
87
+ readonly seed?: number_seed;
88
+ /**
89
+ * Maximum number of tokens that can be generated by the model
90
+ *
91
+ * Note: [ðŸŒū]
92
+ */
93
+ readonly maxTokens?: number;
94
+ };
95
+ /**
96
+ * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (simmilar that `user` identification is not here)
97
+ * TODO: [🧠][ðŸ’ą] Add more model options: `stop_token`, `logit_bias`, `logprobs` (`top_logprobs`), `top_k`, `top_p`, `presence_penalty`, `frequency_penalty`, `bestOf`, `logitBias`, `logitBiasType`,...
98
+ * [ðŸ’ą] Probbably keep using just `temperature` in Promptbook (not `top_k` and `top_p`)
99
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
100
+ * TODO: Maybe figure out better word than "variant"
101
+ * TODO: Add here more requirement options like max context size, max tokens, etc.
102
+ * TODO: [💕][🧠] Just selecting gpt3 or gpt4 level of model
103
+ * TODO: [🧄] Replace all "github.com/webgptorg/promptbook#xxx" with "ptbk.io/xxx"
104
+ */
@@ -0,0 +1,15 @@
1
+ import type { TupleToUnion } from 'type-fest';
2
+ /**
3
+ * Model variant describes the very general type of the model
4
+ *
5
+ * There are two variants:
6
+ * - **COMPLETION** - model that takes prompt and writes the rest of the text
7
+ * - **CHAT** - model that takes prompt and previous messages and returns response
8
+ */
9
+ export type ModelVariant = TupleToUnion<typeof MODEL_VARIANTS>;
10
+ /**
11
+ * @@@
12
+ *
13
+ * @public exported from `@promptbook/core`
14
+ */
15
+ export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Represents an array that is guaranteed to have at least one element
3
+ */
4
+ export type NonEmptyArray<TItem> = [TItem, ...TItem[]];
5
+ /**
6
+ * Represents an array that is guaranteed to have at least one element and is readonly
7
+ */
8
+ export type NonEmptyReadonlyArray<TItem> = ReadonlyArray<TItem> & NonEmptyArray<TItem>;
@@ -0,0 +1,111 @@
1
+ import type { FormatCommand } from '../commands/FORMAT/FormatCommand';
2
+ import type { Expectations } from '../pipeline/PipelineJson/Expectations';
3
+ import type { ChatModelRequirements } from './ModelRequirements';
4
+ import type { CompletionModelRequirements } from './ModelRequirements';
5
+ import type { EmbeddingModelRequirements } from './ModelRequirements';
6
+ import type { ModelRequirements } from './ModelRequirements';
7
+ import type { Parameters } from './typeAliases';
8
+ import type { string_pipeline_url_with_task_hash } from './typeAliases';
9
+ import type { string_postprocessing_function_name } from './typeAliases';
10
+ import type { string_prompt } from './typeAliases';
11
+ import type { string_template } from './typeAliases';
12
+ import type { string_title } from './typeAliases';
13
+ /**
14
+ * Prompt in a text along with model requirements, but without any execution or templating logic.
15
+ *
16
+ * Note: [🚉] This is fully serializable as JSON
17
+ * @see https://github.com/webgptorg/promptbook#prompt
18
+ */
19
+ export type Prompt = CompletionPrompt | ChatPrompt | EmbeddingPrompt;
20
+ /**
21
+ * Completion prompt
22
+ *
23
+ * Note: [🚉] This is fully serializable as JSON
24
+ */
25
+ export type CompletionPrompt = CommonPrompt & {
26
+ /**
27
+ * Requirements for completion model
28
+ */
29
+ modelRequirements: CompletionModelRequirements;
30
+ };
31
+ /**
32
+ * Chat prompt
33
+ *
34
+ * Note: [🚉] This is fully serializable as JSON
35
+ */
36
+ export type ChatPrompt = CommonPrompt & {
37
+ /**
38
+ * Requirements for chat model
39
+ */
40
+ modelRequirements: ChatModelRequirements;
41
+ };
42
+ /**
43
+ * Embedding prompt
44
+ *
45
+ * Note: [🚉] This is fully serializable as JSON
46
+ */
47
+ export type EmbeddingPrompt = CommonPrompt & {
48
+ /**
49
+ * Requirements for chat model
50
+ */
51
+ modelRequirements: EmbeddingModelRequirements;
52
+ };
53
+ /**
54
+ * Common properties for all prompt results
55
+ *
56
+ * Note: [🚉] This is fully serializable as JSON
57
+ *
58
+ * @private just abstract the common properties of the prompts
59
+ */
60
+ export type CommonPrompt = {
61
+ /**
62
+ * The title of the prompt
63
+ *
64
+ * Note: This has no effect on the model, it is just for the reporting
65
+ */
66
+ readonly title: string_title;
67
+ /**
68
+ * The text of the prompt with placeholders for parameters
69
+ *
70
+ * @example "What is the capital of {country}?"
71
+ */
72
+ readonly content: string_prompt & string_template;
73
+ /**
74
+ * Requirements for the model
75
+ */
76
+ readonly modelRequirements: ModelRequirements;
77
+ /**
78
+ * List of postprocessing steps that are executed after the prompt
79
+ */
80
+ readonly postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>;
81
+ /**
82
+ * Expectations for the answer
83
+ *
84
+ * For example 5 words, 3 sentences, 2 paragraphs, ...
85
+ * If not set, nothing is expected from the answer
86
+ */
87
+ readonly expectations?: Expectations;
88
+ /**
89
+ * Expect this format of the answer
90
+ *
91
+ * Note: Expectations are performed after all postprocessing steps
92
+ * @deprecated [💝]
93
+ */
94
+ readonly format?: FormatCommand['format'];
95
+ /**
96
+ * Unique identifier of the pipeline with specific task name as hash
97
+ *
98
+ * @example https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords
99
+ */
100
+ readonly pipelineUrl?: string_pipeline_url_with_task_hash;
101
+ /**
102
+ * Parameters used in the `content`
103
+ */
104
+ readonly parameters: Parameters;
105
+ };
106
+ /**
107
+ * TODO: [🧄] Replace all "github.com/webgptorg/promptbook#xxx" with "ptbk.io/xxx"
108
+ * TODO: [✔] Check ModelRequirements in runtime
109
+ * TODO: [ðŸģ] Add options for translation - maybe create `TranslationPrompt`
110
+ * TODO: [🧠][ðŸĪš] Maybe allow overriding of `userId` for each prompt
111
+ */
@@ -0,0 +1,13 @@
1
+ import type { TupleToUnion } from 'type-fest';
2
+ /**
3
+ * Script language
4
+ *
5
+ * Note: [🚉] This is fully serializable as JSON
6
+ */
7
+ export type ScriptLanguage = TupleToUnion<typeof SUPPORTED_SCRIPT_LANGUAGES>;
8
+ /**
9
+ * Supported script languages
10
+ *
11
+ * @private internal base for `ScriptLanguage`
12
+ */
13
+ export declare const SUPPORTED_SCRIPT_LANGUAGES: readonly ["javascript", "typescript", "python"];
@@ -0,0 +1,21 @@
1
+ import type { TupleToUnion } from 'type-fest';
2
+ /**
3
+ * Type of the section
4
+ */
5
+ export type SectionType = TupleToUnion<typeof SectionTypes>;
6
+ /**
7
+ * All available sections which are not tasks
8
+ *
9
+ * @public exported from `@promptbook/core`
10
+ */
11
+ export declare const NonTaskSectionTypes: readonly ["EXAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];
12
+ /**
13
+ * All available section types
14
+ *
15
+ * There is is distinction between task types and section types
16
+ * - Every section in markdown has its SectionType
17
+ * - Some sections are tasks but other can be non-task sections
18
+ *
19
+ * @public exported from `@promptbook/core`
20
+ */
21
+ export declare const SectionTypes: readonly [...("PROMPT_TASK" | "SIMPLE_TASK" | "SCRIPT_TASK" | "DIALOG_TASK")[], "EXAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];