@promptbook/node 0.72.0-0 → 0.72.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 (247) hide show
  1. package/README.md +15 -6
  2. package/esm/index.es.js +5614 -3612
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/src/_packages/browser.index.d.ts +3 -1
  5. package/esm/typings/src/_packages/cli.index.d.ts +24 -0
  6. package/esm/typings/src/_packages/core.index.d.ts +47 -15
  7. package/esm/typings/src/_packages/documents.index.d.ts +8 -0
  8. package/esm/typings/src/_packages/legacy-documents.index.d.ts +8 -0
  9. package/esm/typings/src/_packages/markdown-utils.index.d.ts +6 -0
  10. package/esm/typings/src/_packages/node.index.d.ts +16 -6
  11. package/esm/typings/src/_packages/openai.index.d.ts +4 -0
  12. package/esm/typings/src/_packages/pdf.index.d.ts +8 -0
  13. package/esm/typings/src/_packages/types.index.d.ts +61 -27
  14. package/esm/typings/src/_packages/utils.index.d.ts +4 -4
  15. package/esm/typings/src/_packages/website-crawler.index.d.ts +8 -0
  16. package/esm/typings/src/cli/cli-commands/about.d.ts +1 -1
  17. package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
  18. package/esm/typings/src/cli/cli-commands/make.d.ts +1 -1
  19. package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
  20. package/esm/typings/src/cli/cli-commands/test-command.d.ts +13 -0
  21. package/esm/typings/src/cli/main.d.ts +1 -1
  22. package/esm/typings/src/cli/promptbookCli.d.ts +1 -1
  23. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +11 -6
  24. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +1 -1
  25. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +1 -1
  26. package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts +3 -2
  27. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +27 -0
  28. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +2 -2
  29. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +1 -1
  30. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +1 -1
  31. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +1 -1
  32. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.d.ts +11 -0
  33. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.test.d.ts +4 -0
  34. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +1 -1
  35. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +1 -1
  36. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +1 -1
  37. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +1 -1
  38. package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +1 -1
  39. package/esm/typings/src/commands/TEMPLATE/templateCommandParser.d.ts +1 -1
  40. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +1 -1
  41. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +1 -1
  42. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +1 -1
  43. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -1
  44. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +16 -1
  45. package/esm/typings/src/config.d.ts +30 -1
  46. package/esm/typings/src/conversion/pipelineStringToJson.d.ts +4 -15
  47. package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +1 -1
  48. package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +3 -0
  49. package/esm/typings/src/conversion/utils/extractParameterNamesFromTemplate.d.ts +2 -1
  50. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +1 -1
  51. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +10 -5
  52. package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceTools.d.ts +2 -2
  53. package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceToolsOptions.d.ts +3 -3
  54. package/esm/typings/src/{knowledge/dialogs → dialogs}/simple-prompt/SimplePromptInterfaceTools.d.ts +6 -6
  55. package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
  56. package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
  57. package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
  58. package/esm/typings/src/execution/{CommonExecutionToolsOptions.d.ts → CommonToolsOptions.d.ts} +1 -1
  59. package/esm/typings/src/execution/ExecutionTools.d.ts +29 -9
  60. package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
  61. package/esm/typings/src/execution/PipelineExecutor.d.ts +1 -0
  62. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +9 -8
  63. package/esm/typings/src/execution/createPipelineExecutor/$OngoingTemplateResult.d.ts +45 -0
  64. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +23 -0
  65. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts +29 -0
  66. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +13 -0
  67. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +58 -0
  68. package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts +60 -0
  69. package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +15 -0
  70. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +69 -0
  71. package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +34 -0
  72. package/esm/typings/src/execution/createPipelineExecutor/getContextForTemplate.d.ts +10 -0
  73. package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTemplate.d.ts +27 -0
  74. package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTemplate.d.ts +30 -0
  75. package/esm/typings/src/execution/createPipelineExecutor/getSamplesForTemplate.d.ts +10 -0
  76. package/esm/typings/src/execution/embeddingVectorToString.d.ts +1 -1
  77. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +4 -0
  78. package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
  79. package/esm/typings/src/execution/utils/checkExpectations.d.ts +2 -0
  80. package/esm/typings/src/execution/utils/forEachAsync.d.ts +1 -0
  81. package/esm/typings/src/execution/utils/usageToHuman.d.ts +3 -4
  82. package/esm/typings/src/formats/_common/FormatDefinition.d.ts +14 -15
  83. package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +31 -0
  84. package/esm/typings/src/formats/csv/{ListFormatDefinition.d.ts → CsvFormatDefinition.d.ts} +6 -3
  85. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  86. package/esm/typings/src/formats/csv/CsvSettings.d.ts +13 -0
  87. package/esm/typings/src/formats/index.d.ts +1 -1
  88. package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts +4 -3
  89. package/esm/typings/src/formats/text/TextFormatDefinition.d.ts +19 -0
  90. package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts +4 -3
  91. package/esm/typings/src/llm-providers/_common/{$llmToolsMetadataRegister.d.ts → register/$llmToolsMetadataRegister.d.ts} +4 -1
  92. package/esm/typings/src/llm-providers/_common/{$llmToolsRegister.d.ts → register/$llmToolsRegister.d.ts} +5 -2
  93. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfigurationFromEnv.d.ts → register/$provideLlmToolsConfigurationFromEnv.d.ts} +3 -3
  94. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForCli.d.ts +15 -0
  95. package/esm/typings/src/llm-providers/_common/{getLlmToolsForTestingAndScriptsAndPlayground.d.ts → register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts} +4 -3
  96. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromEnv.d.ts → register/$provideLlmToolsFromEnv.d.ts} +6 -5
  97. package/esm/typings/src/llm-providers/_common/{$registeredLlmToolsMessage.d.ts → register/$registeredLlmToolsMessage.d.ts} +5 -2
  98. package/esm/typings/src/llm-providers/_common/{LlmToolsConfiguration.d.ts → register/LlmToolsConfiguration.d.ts} +5 -4
  99. package/esm/typings/src/llm-providers/_common/{LlmToolsMetadata.d.ts → register/LlmToolsMetadata.d.ts} +5 -4
  100. package/esm/typings/src/llm-providers/_common/{LlmToolsOptions.d.ts → register/LlmToolsOptions.d.ts} +4 -1
  101. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfiguration.d.ts → register/createLlmToolsFromConfiguration.d.ts} +5 -4
  102. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +5 -5
  103. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +3 -2
  104. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +4 -3
  105. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +4 -3
  106. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +6 -0
  107. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +4 -3
  108. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +1 -0
  109. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +4 -3
  110. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +4 -3
  111. package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +1 -1
  112. package/esm/typings/src/llm-providers/langtail/playground/playground.d.ts +3 -0
  113. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +3 -3
  114. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +3 -3
  115. package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +1 -0
  116. package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts +3 -0
  117. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +2 -2
  118. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +1 -1
  119. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +10 -1
  120. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +4 -4
  121. package/esm/typings/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +15 -0
  122. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +2 -1
  123. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +11 -1
  124. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +11 -1
  125. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +3 -3
  126. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts +16 -7
  127. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts +2 -2
  128. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts +7 -13
  129. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Response.d.ts +1 -1
  130. package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts +11 -16
  131. package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts +23 -9
  132. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +3 -0
  133. package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts +1 -1
  134. package/esm/typings/src/personas/preparePersona.d.ts +3 -2
  135. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +68 -0
  136. package/esm/typings/src/prepare/preparePipeline.d.ts +3 -2
  137. package/esm/typings/src/prepare/prepareTemplates.d.ts +3 -2
  138. package/esm/typings/src/scrapers/_common/Converter.d.ts +22 -0
  139. package/esm/typings/src/scrapers/_common/Scraper.d.ts +66 -0
  140. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +11 -0
  141. package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.d.ts +5 -4
  142. package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +11 -0
  143. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +12 -0
  144. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +15 -0
  145. package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +12 -0
  146. package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
  147. package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +13 -0
  148. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +41 -0
  149. package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +12 -0
  150. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +34 -0
  151. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  152. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +11 -0
  153. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
  154. package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
  155. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
  156. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  157. package/esm/typings/src/scrapers/document/register-constructor.d.ts +13 -0
  158. package/esm/typings/src/scrapers/document/register-metadata.d.ts +24 -0
  159. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
  160. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
  161. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +20 -0
  162. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  163. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +13 -0
  164. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +24 -0
  165. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
  166. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
  167. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  168. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +13 -0
  169. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +24 -0
  170. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +40 -0
  171. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +20 -0
  172. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  173. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +13 -0
  174. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +24 -0
  175. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +47 -0
  176. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +20 -0
  177. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  178. package/esm/typings/src/scrapers/website/register-constructor.d.ts +13 -0
  179. package/esm/typings/src/scrapers/website/register-metadata.d.ts +24 -0
  180. package/esm/typings/src/scrapers/website/utils/markdownConverter.d.ts +12 -0
  181. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +2 -2
  182. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +3 -3
  183. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +3 -3
  184. package/esm/typings/src/storage/{files-storage/FilesStorage.d.ts → file-cache-storage/FileCacheStorage.d.ts} +7 -5
  185. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +10 -0
  186. package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.d.ts +1 -1
  187. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +1 -1
  188. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +1 -1
  189. package/esm/typings/src/storage/{utils → memory/utils}/PrefixStorage.d.ts +1 -1
  190. package/esm/typings/src/storage/{utils → memory/utils}/makePromptbookStorageFromWebStorage.d.ts +1 -1
  191. package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts +9 -2
  192. package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts +1 -0
  193. package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +2 -2
  194. package/esm/typings/src/types/PipelineJson/TemplateJsonCommon.d.ts +5 -0
  195. package/esm/typings/src/types/Prompt.d.ts +1 -0
  196. package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts +2 -1
  197. package/esm/typings/src/types/typeAliases.d.ts +27 -20
  198. package/esm/typings/src/utils/$Register.d.ts +19 -6
  199. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +14 -0
  200. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +17 -0
  201. package/esm/typings/src/utils/execCommand/IExecCommandOptions.d.ts +23 -0
  202. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts +10 -0
  203. package/esm/typings/src/utils/expectation-counters/index.d.ts +3 -0
  204. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  205. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  206. package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
  207. package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
  208. package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
  209. package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
  210. package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
  211. package/esm/typings/src/utils/organization/{f.d.ts → empty_object.d.ts} +5 -1
  212. package/esm/typings/src/utils/organization/just_empty_object.d.ts +12 -0
  213. package/esm/typings/src/utils/{extractParameterNames.d.ts → parameters/extractParameterNames.d.ts} +2 -2
  214. package/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts +1 -0
  215. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +27 -0
  216. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts +1 -0
  217. package/esm/typings/src/utils/{replaceParameters.d.ts → parameters/replaceParameters.d.ts} +2 -2
  218. package/esm/typings/src/utils/parameters/replaceParameters.test.d.ts +1 -0
  219. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +2 -2
  220. package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts +10 -0
  221. package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts +1 -0
  222. package/package.json +19 -13
  223. package/umd/index.umd.js +5619 -3615
  224. package/umd/index.umd.js.map +1 -1
  225. package/esm/typings/src/execution/createPipelineExecutor.d.ts +0 -72
  226. package/esm/typings/src/formats/list/ListFormatDefinition.d.ts +0 -16
  227. package/esm/typings/src/knowledge/prepare-knowledge/_common/Scraper.d.ts +0 -37
  228. package/esm/typings/src/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts +0 -2
  229. package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +0 -14
  230. package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +0 -15
  231. package/esm/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts +0 -22
  232. package/esm/typings/src/prepare/PrepareOptions.d.ts +0 -22
  233. package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts +0 -10
  234. package/esm/typings/src/utils/files/$isDirectoryExisting.d.ts +0 -15
  235. package/esm/typings/src/utils/files/$isFileExisting.d.ts +0 -14
  236. package/esm/typings/src/utils/files/$listAllFiles.d.ts +0 -17
  237. /package/esm/typings/src/{knowledge/dialogs → dialogs}/user-interface-execution-tools.test.d.ts +0 -0
  238. /package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.test.d.ts +0 -0
  239. /package/esm/typings/src/{knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts → scrapers/markdown/MarkdownScraper.test.d.ts} +0 -0
  240. /package/esm/typings/src/{execution/utils/usageToHuman.test.d.ts → scrapers/website/WebsiteScraper.test.d.ts} +0 -0
  241. /package/esm/typings/src/{knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts → scrapers/website/utils/markdownConverter.test.d.ts} +0 -0
  242. /package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.test.d.ts +0 -0
  243. /package/esm/typings/src/utils/{extractParameterNames.test.d.ts → execCommand/execCommand.test.d.ts} +0 -0
  244. /package/esm/typings/src/utils/{files/$isDirectoryExisting.test.d.ts → execCommand/execCommandNormalizeOptions.test.d.ts} +0 -0
  245. /package/esm/typings/src/utils/files/{$isFileExisting.test.d.ts → extensionToMimeType.test.d.ts} +0 -0
  246. /package/esm/typings/src/utils/files/{$listAllFiles.test.d.ts → getFileExtension.test.d.ts} +0 -0
  247. /package/esm/typings/src/utils/{replaceParameters.test.d.ts → files/isDirectoryExisting.test.d.ts} +0 -0
package/README.md CHANGED
@@ -16,6 +16,16 @@ Supercharge your use of large language models
16
16
 
17
17
 
18
18
 
19
+ ## ✨ New Features
20
+
21
+ - ✨ **Support of [OpenAI o1 model](https://openai.com/o1/)**
22
+
23
+ <blockquote style="color: #ff8811">
24
+ <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
25
+ </blockquote>
26
+
27
+
28
+
19
29
  ## 📦 Package `@promptbook/node`
20
30
 
21
31
  - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -28,7 +38,7 @@ To install this package, run:
28
38
  npm i ptbk
29
39
 
30
40
  # Install just this package to save space
31
- npm i @promptbook/node
41
+ npm install @promptbook/node
32
42
  ```
33
43
 
34
44
  Core of the library for Node.js runtime, it contains the main logic for promptbooks which uses filesystem.
@@ -42,10 +52,6 @@ Core of the library for Node.js runtime, it contains the main logic for promptbo
42
52
 
43
53
  Rest of the documentation is common for **entire promptbook ecosystem**:
44
54
 
45
- # ✨ New Features
46
-
47
- - ✨ **Support [OpenAI o1 model](https://openai.com/o1/)**
48
-
49
55
  ## 🤍 The Promptbook Whitepaper
50
56
 
51
57
 
@@ -92,7 +98,6 @@ File `write-website-content.ptbk.md`:
92
98
  > Instructions for creating web page content.
93
99
  >
94
100
  > - PIPELINE URL https://promptbook.studio/webgpt/write-website-content.ptbk.md
95
- > - PROMPTBOOK VERSION 0.0.1
96
101
  > - INPUT  PARAM `{rawTitle}` Automatically suggested a site name or empty text
97
102
  > - INPUT  PARAM `{rawAssigment}` Automatically generated site entry from image recognition
98
103
  > - OUTPUT PARAM `{websiteContent}` Web content
@@ -331,6 +336,10 @@ Or you can install them separately:
331
336
  - **[@promptbook/fake-llm](https://www.npmjs.com/package/@promptbook/fake-llm)** - Mocked execution tools for testing the library and saving the tokens
332
337
  - **[@promptbook/remote-client](https://www.npmjs.com/package/@promptbook/remote-client)** - Remote client for remote execution of promptbooks
333
338
  - **[@promptbook/remote-server](https://www.npmjs.com/package/@promptbook/remote-server)** - Remote server for remote execution of promptbooks
339
+ - **[@promptbook/pdf](https://www.npmjs.com/package/@promptbook/pdf)** - Read knowledge from `.pdf` documents
340
+ - **[@promptbook/documents](https://www.npmjs.com/package/@promptbook/documents)** - Read knowledge from documents like `.docx`, `.odt`,…
341
+ - **[@promptbook/legacy-documents](https://www.npmjs.com/package/@promptbook/legacy-documents)** - Read knowledge from legacy documents like `.doc`, `.rtf`,…
342
+ - **[@promptbook/website-crawler](https://www.npmjs.com/package/@promptbook/website-crawler)** - Crawl knowledge from the web
334
343
  - **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
335
344
  - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
336
345