@promptbook/utils 0.72.0-2 → 0.72.0-23

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 (255) hide show
  1. package/README.md +11 -1
  2. package/esm/index.es.js +72 -75
  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 +16 -0
  6. package/esm/typings/src/_packages/core.index.d.ts +54 -28
  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 +18 -6
  11. package/esm/typings/src/_packages/pdf.index.d.ts +8 -0
  12. package/esm/typings/src/_packages/types.index.d.ts +57 -33
  13. package/esm/typings/src/_packages/utils.index.d.ts +2 -2
  14. package/esm/typings/src/cli/cli-commands/about.d.ts +1 -1
  15. package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
  16. package/esm/typings/src/cli/cli-commands/make.d.ts +1 -1
  17. package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
  18. package/esm/typings/src/cli/cli-commands/test-command.d.ts +13 -0
  19. package/esm/typings/src/cli/main.d.ts +1 -1
  20. package/esm/typings/src/cli/promptbookCli.d.ts +1 -1
  21. package/esm/typings/src/collection/PipelineCollection.d.ts +1 -1
  22. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +2 -2
  23. package/esm/typings/src/collection/collectionToJson.d.ts +1 -1
  24. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +11 -6
  25. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +1 -1
  26. package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +1 -1
  27. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +1 -1
  28. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +1 -1
  29. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +5 -1
  30. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +1 -1
  31. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +1 -1
  32. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +1 -1
  33. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +1 -1
  34. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.d.ts +11 -0
  35. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.test.d.ts +4 -0
  36. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +1 -1
  37. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +1 -1
  38. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +1 -1
  39. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +1 -1
  40. package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +1 -1
  41. package/esm/typings/src/commands/TEMPLATE/templateCommandParser.d.ts +1 -1
  42. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +1 -1
  43. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +1 -1
  44. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +1 -1
  45. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -1
  46. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +5 -5
  47. package/esm/typings/src/config.d.ts +35 -12
  48. package/esm/typings/src/conversion/pipelineStringToJson.d.ts +4 -15
  49. package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +1 -1
  50. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +1 -1
  51. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +5 -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/executables/$provideExecutablesForNode.d.ts +12 -0
  59. package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +11 -0
  60. package/esm/typings/src/executables/apps/locatePandoc.d.ts +11 -0
  61. package/esm/typings/src/executables/locateApp.d.ts +33 -0
  62. package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +12 -0
  63. package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +12 -0
  64. package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +12 -0
  65. package/esm/typings/src/execution/{CommonExecutionToolsOptions.d.ts → CommonToolsOptions.d.ts} +1 -1
  66. package/esm/typings/src/execution/EmbeddingVector.d.ts +1 -1
  67. package/esm/typings/src/execution/Executables.d.ts +18 -0
  68. package/esm/typings/src/execution/ExecutionTools.d.ts +35 -9
  69. package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
  70. package/esm/typings/src/execution/LlmExecutionTools.d.ts +2 -2
  71. package/esm/typings/src/execution/PipelineExecutor.d.ts +1 -0
  72. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +2 -2
  73. package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +3 -2
  74. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +31 -5
  75. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +3 -0
  76. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +6 -12
  77. package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts +7 -18
  78. package/esm/typings/src/execution/createPipelineExecutor/{30-executeFormatCells.d.ts → 30-executeFormatSubvalues.d.ts} +2 -6
  79. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +9 -19
  80. package/esm/typings/src/execution/embeddingVectorToString.d.ts +1 -1
  81. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +11 -3
  82. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +4 -0
  83. package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
  84. package/esm/typings/src/execution/utils/addUsage.d.ts +1 -1
  85. package/esm/typings/src/execution/utils/forEachAsync.d.ts +2 -1
  86. package/esm/typings/src/formats/_common/FormatDefinition.d.ts +2 -2
  87. package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +3 -2
  88. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  89. package/esm/typings/src/llm-providers/_common/{$llmToolsMetadataRegister.d.ts → register/$llmToolsMetadataRegister.d.ts} +4 -1
  90. package/esm/typings/src/llm-providers/_common/{$llmToolsRegister.d.ts → register/$llmToolsRegister.d.ts} +5 -2
  91. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfigurationFromEnv.d.ts → register/$provideLlmToolsConfigurationFromEnv.d.ts} +3 -3
  92. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForCli.d.ts +15 -0
  93. package/esm/typings/src/llm-providers/_common/{getLlmToolsForTestingAndScriptsAndPlayground.d.ts → register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts} +4 -3
  94. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromEnv.d.ts → register/$provideLlmToolsFromEnv.d.ts} +6 -5
  95. package/esm/typings/src/llm-providers/_common/{$registeredLlmToolsMessage.d.ts → register/$registeredLlmToolsMessage.d.ts} +5 -2
  96. package/esm/typings/src/llm-providers/_common/{LlmToolsConfiguration.d.ts → register/LlmToolsConfiguration.d.ts} +6 -5
  97. package/esm/typings/src/llm-providers/_common/{LlmToolsMetadata.d.ts → register/LlmToolsMetadata.d.ts} +5 -4
  98. package/esm/typings/src/llm-providers/_common/{LlmToolsOptions.d.ts → register/LlmToolsOptions.d.ts} +4 -1
  99. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfiguration.d.ts → register/createLlmToolsFromConfiguration.d.ts} +12 -4
  100. package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +4 -1
  101. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +1 -1
  102. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +5 -5
  103. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  104. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +3 -2
  105. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +4 -3
  106. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +4 -3
  107. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +7 -1
  108. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +4 -3
  109. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +1 -0
  110. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +4 -3
  111. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +4 -3
  112. package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +1 -1
  113. package/esm/typings/src/llm-providers/langtail/playground/playground.d.ts +3 -0
  114. package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +1 -1
  115. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +4 -4
  116. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +4 -4
  117. package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +4 -4
  118. package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +1 -1
  119. package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts +3 -0
  120. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +1 -2
  121. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +2 -2
  122. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +4 -4
  123. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
  124. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +2 -1
  125. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +5 -4
  126. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +5 -4
  127. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +4 -4
  128. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts +16 -7
  129. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts +4 -4
  130. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts +7 -13
  131. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Response.d.ts +3 -3
  132. package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts +11 -16
  133. package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts +24 -9
  134. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +3 -0
  135. package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts +1 -1
  136. package/esm/typings/src/personas/preparePersona.d.ts +3 -2
  137. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +49 -0
  138. package/esm/typings/src/prepare/preparePipeline.d.ts +3 -2
  139. package/esm/typings/src/prepare/prepareTemplates.d.ts +4 -3
  140. package/esm/typings/src/scrapers/_common/Converter.d.ts +22 -0
  141. package/esm/typings/src/scrapers/_common/Scraper.d.ts +59 -0
  142. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +11 -0
  143. package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.d.ts +5 -4
  144. package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +11 -0
  145. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +12 -0
  146. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +15 -0
  147. package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +12 -0
  148. package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
  149. package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +13 -0
  150. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +41 -0
  151. package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +12 -0
  152. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +34 -0
  153. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  154. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +11 -0
  155. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
  156. package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
  157. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
  158. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  159. package/esm/typings/src/scrapers/document/register-constructor.d.ts +13 -0
  160. package/esm/typings/src/scrapers/document/register-metadata.d.ts +24 -0
  161. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
  162. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
  163. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +20 -0
  164. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  165. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +13 -0
  166. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +24 -0
  167. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
  168. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
  169. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  170. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +13 -0
  171. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +24 -0
  172. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +40 -0
  173. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +20 -0
  174. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  175. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +13 -0
  176. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +24 -0
  177. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +2 -2
  178. package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +1 -1
  179. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +3 -3
  180. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +3 -3
  181. package/esm/typings/src/storage/{files-storage/FilesStorage.d.ts → file-cache-storage/FileCacheStorage.d.ts} +7 -5
  182. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +10 -0
  183. package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.d.ts +2 -2
  184. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +1 -1
  185. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +1 -1
  186. package/esm/typings/src/storage/{utils → memory/utils}/PrefixStorage.d.ts +1 -1
  187. package/esm/typings/src/storage/{utils → memory/utils}/makePromptbookStorageFromWebStorage.d.ts +1 -1
  188. package/esm/typings/src/types/Arrayable.d.ts +1 -1
  189. package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +7 -0
  190. package/esm/typings/src/types/PipelineJson/KnowledgePieceJson.d.ts +4 -4
  191. package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts +10 -3
  192. package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts +1 -1
  193. package/esm/typings/src/types/PipelineJson/PersonaJson.d.ts +1 -1
  194. package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +2 -2
  195. package/esm/typings/src/types/PipelineJson/TemplateJsonCommon.d.ts +2 -2
  196. package/esm/typings/src/types/Prompt.d.ts +2 -1
  197. package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts +1 -4
  198. package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts +2 -1
  199. package/esm/typings/src/types/typeAliases.d.ts +27 -20
  200. package/esm/typings/src/utils/$Register.d.ts +20 -7
  201. package/esm/typings/src/utils/FromtoItems.d.ts +1 -1
  202. package/esm/typings/src/utils/arrayableToArray.d.ts +1 -1
  203. package/esm/typings/src/utils/emojis.d.ts +1 -1
  204. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +14 -0
  205. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +17 -0
  206. package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts +19 -0
  207. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts +10 -0
  208. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts +1 -0
  209. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +1 -1
  210. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  211. package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts +1 -0
  212. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  213. package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
  214. package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
  215. package/esm/typings/src/utils/files/isDirectoryExisting.test.d.ts +1 -0
  216. package/esm/typings/src/utils/files/isExecutable.d.ts +11 -0
  217. package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
  218. package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
  219. package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
  220. package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
  221. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +1 -1
  222. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +1 -1
  223. package/esm/typings/src/utils/normalization/IKeywords.d.ts +2 -2
  224. package/esm/typings/src/utils/normalization/parseKeywords.d.ts +2 -2
  225. package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +2 -2
  226. package/esm/typings/src/utils/normalization/searchKeywords.d.ts +2 -2
  227. package/esm/typings/src/utils/organization/TODO_USE.d.ts +1 -1
  228. package/esm/typings/src/utils/organization/keepUnused.d.ts +1 -1
  229. package/esm/typings/src/utils/random/$randomSeed.d.ts +1 -1
  230. package/esm/typings/src/utils/sets/intersection.d.ts +1 -1
  231. package/esm/typings/src/utils/sets/union.d.ts +1 -1
  232. package/esm/typings/src/utils/unwrapResult.d.ts +4 -4
  233. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +2 -2
  234. package/package.json +3 -2
  235. package/umd/index.umd.js +75 -79
  236. package/umd/index.umd.js.map +1 -1
  237. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts +0 -40
  238. package/esm/typings/src/knowledge/prepare-knowledge/_common/Scraper.d.ts +0 -37
  239. package/esm/typings/src/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts +0 -2
  240. package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +0 -14
  241. package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +0 -15
  242. package/esm/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts +0 -22
  243. package/esm/typings/src/prepare/PrepareOptions.d.ts +0 -22
  244. package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts +0 -10
  245. package/esm/typings/src/utils/files/$isDirectoryExisting.d.ts +0 -15
  246. package/esm/typings/src/utils/files/$isFileExisting.d.ts +0 -14
  247. package/esm/typings/src/utils/files/$listAllFiles.d.ts +0 -17
  248. /package/esm/typings/src/{knowledge/dialogs → dialogs}/user-interface-execution-tools.test.d.ts +0 -0
  249. /package/esm/typings/src/{knowledge/prepare-knowledge/_common/prepareKnowledgePieces.test.d.ts → executables/apps/locateLibreoffice.test.d.ts} +0 -0
  250. /package/esm/typings/src/{knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts → executables/apps/locatePandoc.test.d.ts} +0 -0
  251. /package/esm/typings/src/{storage/files-storage/utils/nameToSubfolderPath.test.d.ts → executables/locateApp.test.d.ts} +0 -0
  252. /package/esm/typings/src/{utils/files/$isDirectoryExisting.test.d.ts → scrapers/_common/prepareKnowledgePieces.test.d.ts} +0 -0
  253. /package/esm/typings/src/{knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts → scrapers/markdown/MarkdownScraper.test.d.ts} +0 -0
  254. /package/esm/typings/src/{utils/files/$isFileExisting.test.d.ts → storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts} +0 -0
  255. /package/esm/typings/src/utils/{files/$listAllFiles.test.d.ts → execCommand/execCommand.test.d.ts} +0 -0
@@ -1,5 +1,5 @@
1
1
  import type { really_unknown } from '../organization/really_unknown';
2
- import type { IKeywords } from './IKeywords';
2
+ import type { Keywords } from './IKeywords';
3
3
  /**
4
4
  * Parses keywords from any object and recursively walks through
5
5
  *
@@ -9,7 +9,7 @@ import type { IKeywords } from './IKeywords';
9
9
  * @returns {Set} of keywords without diacritics in lowercase
10
10
  * @public exported from `@promptbook/utils`
11
11
  */
12
- export declare function parseKeywords(input: really_unknown): IKeywords;
12
+ export declare function parseKeywords(input: really_unknown): Keywords;
13
13
  /**
14
14
  * Note: Not using spread in input param because of keeping second parameter for options
15
15
  * TODO: [🌺] Use some intermediate util splitWords
@@ -1,4 +1,4 @@
1
- import type { IKeywords } from './IKeywords';
1
+ import type { Keywords } from './IKeywords';
2
2
  /**
3
3
  * Parses keywords from a string
4
4
  *
@@ -6,4 +6,4 @@ import type { IKeywords } from './IKeywords';
6
6
  * @returns {Set} of keywords without diacritics in lowercase
7
7
  * @public exported from `@promptbook/utils`
8
8
  */
9
- export declare function parseKeywordsFromString(input: string): IKeywords;
9
+ export declare function parseKeywordsFromString(input: string): Keywords;
@@ -1,4 +1,4 @@
1
- import type { IKeywords } from './IKeywords';
1
+ import type { Keywords } from './IKeywords';
2
2
  /**
3
3
  * @@@
4
4
  *
@@ -7,4 +7,4 @@ import type { IKeywords } from './IKeywords';
7
7
  * @returns
8
8
  * @public exported from `@promptbook/utils`
9
9
  */
10
- export declare function searchKeywords(haystack: IKeywords, needle: IKeywords): boolean;
10
+ export declare function searchKeywords(haystack: Keywords, needle: Keywords): boolean;
@@ -9,4 +9,4 @@ import type { really_any } from './really_any';
9
9
  * @returns void
10
10
  * @private within the repository
11
11
  */
12
- export declare function TODO_USE(...value: Array<really_any>): void;
12
+ export declare function TODO_USE(...value: ReadonlyArray<really_any>): void;
@@ -13,4 +13,4 @@ import type { really_any } from './really_any';
13
13
  * @returns void
14
14
  * @private within the repository
15
15
  */
16
- export declare function keepUnused<TTypeToKeep1 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: Array<really_any>): void;
16
+ export declare function keepUnused<TTypeToKeep1 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: ReadonlyArray<really_any>): void;
@@ -3,7 +3,7 @@ import type { number_seed } from '../../types/typeAliases';
3
3
  * Generates random seed
4
4
  *
5
5
  * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
6
- * Warning: This function is not cryptographically secure (it uses Math.random internally)
6
+ * Warning: This function is NOT cryptographically secure (it uses Math.random internally)
7
7
  * @public exported from `@promptbook/utils`
8
8
  */
9
9
  export declare function $randomSeed(): number_seed;
@@ -4,4 +4,4 @@
4
4
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
5
5
  * @public exported from `@promptbook/utils`
6
6
  */
7
- export declare function intersection<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;
7
+ export declare function intersection<TItem>(...sets: ReadonlyArray<Set<TItem>>): Set<TItem>;
@@ -4,4 +4,4 @@
4
4
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
5
5
  * @public exported from `@promptbook/utils`
6
6
  */
7
- export declare function union<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;
7
+ export declare function union<TItem>(...sets: ReadonlyArray<Set<TItem>>): Set<TItem>;
@@ -1,11 +1,11 @@
1
1
  /**
2
2
  * Additional options for `unwrapResult`
3
3
  */
4
- interface UnwrapResultOptions {
4
+ type UnwrapResultOptions = {
5
5
  /**
6
6
  * If true, the text is trimmed before processing
7
7
  */
8
- isTrimmed?: boolean;
8
+ readonly isTrimmed?: boolean;
9
9
  /**
10
10
  * If true, the introduce sentence is removed
11
11
  *
@@ -15,8 +15,8 @@ interface UnwrapResultOptions {
15
15
  *
16
16
  * @default true
17
17
  */
18
- isIntroduceSentenceRemoved?: boolean;
19
- }
18
+ readonly isIntroduceSentenceRemoved?: boolean;
19
+ };
20
20
  /**
21
21
  * Removes quotes and optional introduce text from a string
22
22
  *
@@ -1,4 +1,4 @@
1
- import type { string_file_path } from '../../../types/typeAliases';
1
+ import type { string_filename } from '../../../types/typeAliases';
2
2
  import type { really_unknown } from '../../organization/really_unknown';
3
3
  /**
4
4
  * Tests if given string is valid URL.
@@ -6,4 +6,4 @@ import type { really_unknown } from '../../organization/really_unknown';
6
6
  * Note: This does not check if the file exists only if the path is valid
7
7
  * @public exported from `@promptbook/utils`
8
8
  */
9
- export declare function isValidFilePath(filePath: really_unknown): filePath is string_file_path;
9
+ export declare function isValidFilePath(filename: really_unknown): filename is string_filename;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/utils",
3
- "version": "0.72.0-2",
3
+ "version": "0.72.0-23",
4
4
  "description": "Supercharge your use of large language models",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -11,6 +11,7 @@
11
11
  "contributors": [
12
12
  "Pavol Hejný <me@pavolhejny.com> (https://www.pavolhejny.com/)"
13
13
  ],
14
+ "todo-0": "TODO: [❇️] Make better list of keywords",
14
15
  "keywords": [
15
16
  "ai",
16
17
  "llm",
@@ -51,6 +52,6 @@
51
52
  "module": "./esm/index.es.js",
52
53
  "typings": "./esm/typings/src/_packages/utils.index.d.ts",
53
54
  "dependencies": {
54
- "spacetrim": "0.11.39"
55
+ "spacetrim": "0.11.59"
55
56
  }
56
57
  }
package/umd/index.umd.js CHANGED
@@ -1,8 +1,8 @@
1
1
  (function (global, factory) {
2
- typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('spacetrim')) :
3
- typeof define === 'function' && define.amd ? define(['exports', 'spacetrim'], factory) :
4
- (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-utils"] = {}, global.spaceTrim));
5
- })(this, (function (exports, spaceTrim) { 'use strict';
2
+ typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('spacetrim'), require('path')) :
3
+ typeof define === 'function' && define.amd ? define(['exports', 'spacetrim', 'path'], factory) :
4
+ (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-utils"] = {}, global.spaceTrim, global.path));
5
+ })(this, (function (exports, spaceTrim, path) { 'use strict';
6
6
 
7
7
  function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
8
8
 
@@ -12,8 +12,8 @@
12
12
  /**
13
13
  * The version of the Promptbook library
14
14
  */
15
- var PROMPTBOOK_VERSION = '0.72.0-1';
16
- // TODO:[main] !!!! List here all the versions and annotate + put into script
15
+ var PROMPTBOOK_VERSION = '0.72.0-22';
16
+ // TODO: [main] !!!! List here all the versions and annotate + put into script
17
17
 
18
18
  /*! *****************************************************************************
19
19
  Copyright (c) Microsoft Corporation.
@@ -214,6 +214,35 @@
214
214
  * TODO: [🌺] Use some intermediate util splitWords
215
215
  */
216
216
 
217
+ /**
218
+ * Tests if given string is valid URL.
219
+ *
220
+ * Note: Dataurl are considered perfectly valid.
221
+ * Note: There are two simmilar functions:
222
+ * - `isValidUrl` which tests any URL
223
+ * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
224
+ *
225
+ * @public exported from `@promptbook/utils`
226
+ */
227
+ function isValidUrl(url) {
228
+ if (typeof url !== 'string') {
229
+ return false;
230
+ }
231
+ try {
232
+ if (url.startsWith('blob:')) {
233
+ url = url.replace(/^blob:/, '');
234
+ }
235
+ var urlObject = new URL(url /* because fail is handled */);
236
+ if (!['http:', 'https:', 'data:'].includes(urlObject.protocol)) {
237
+ return false;
238
+ }
239
+ return true;
240
+ }
241
+ catch (error) {
242
+ return false;
243
+ }
244
+ }
245
+
217
246
  var defaultDiacriticsRemovalMap = [
218
247
  {
219
248
  base: 'A',
@@ -506,10 +535,6 @@
506
535
  charType = 'NUMBER';
507
536
  normalizedChar = char;
508
537
  }
509
- else if (/^\/$/.test(char)) {
510
- charType = 'SLASH';
511
- normalizedChar = char;
512
- }
513
538
  else {
514
539
  charType = 'OTHER';
515
540
  normalizedChar = '-';
@@ -554,6 +579,32 @@
554
579
  return text;
555
580
  }
556
581
 
582
+ /**
583
+ * Tests if given string is valid URL.
584
+ *
585
+ * Note: This does not check if the file exists only if the path is valid
586
+ * @public exported from `@promptbook/utils`
587
+ */
588
+ function isValidFilePath(filename) {
589
+ if (typeof filename !== 'string') {
590
+ return false;
591
+ }
592
+ var filenameSlashes = filename.split('\\').join('/');
593
+ // Absolute Unix path: /hello.txt
594
+ if (/^(\/)/i.test(filenameSlashes)) {
595
+ return true;
596
+ }
597
+ // Absolute Windows path: /hello.txt
598
+ if (/^([A-Z]{1,2}:\/?)\//i.test(filenameSlashes)) {
599
+ return true;
600
+ }
601
+ // Relative path: ./hello.txt
602
+ if (/^(\.\.?\/)+/i.test(filenameSlashes)) {
603
+ return true;
604
+ }
605
+ return false;
606
+ }
607
+
557
608
  /**
558
609
  * @@@
559
610
  *
@@ -563,14 +614,15 @@
563
614
  * @public exported from `@promptbook/utils`
564
615
  */
565
616
  function titleToName(value) {
566
- if (value.startsWith('http://') || value.startsWith('https://')) {
567
- // TODO: Maybe check against some list unallowed characters
568
- return value;
617
+ if (isValidUrl(value)) {
618
+ value = value.replace(/^https?:\/\//, '');
619
+ value = value.replace(/\.html$/, '');
569
620
  }
570
- if (value.startsWith('./') || value.startsWith('../')) {
571
- // TODO: Maybe check against some list unallowed characters
572
- return value;
621
+ else if (isValidFilePath(value)) {
622
+ value = path.basename(value);
623
+ // Note: Keeping extension in the name
573
624
  }
625
+ value = value.split('/').join('-');
574
626
  value = removeEmojis(value);
575
627
  value = normalizeToKebabCase(value);
576
628
  // TODO: [🧠] Maybe warn or add some padding to short name which are not good identifiers
@@ -794,7 +846,7 @@
794
846
  // Note: [🍭] Fixing dependent subparameterName from FOREACH command
795
847
  if (foreach !== undefined) {
796
848
  try {
797
- for (var _l = __values(foreach.subparameterNames), _m = _l.next(); !_m.done; _m = _l.next()) {
849
+ for (var _l = __values(foreach.inputSubparameterNames), _m = _l.next(); !_m.done; _m = _l.next()) {
798
850
  var subparameterName = _m.value;
799
851
  if (parameterNames.has(subparameterName)) {
800
852
  parameterNames.delete(subparameterName);
@@ -846,7 +898,9 @@
846
898
  if (pipeline.parameters.some(function (parameter) { return parameter.name === newParameterName; })) {
847
899
  throw new PipelineLogicError("Can not replace {".concat(oldParameterName, "} to {").concat(newParameterName, "} because {").concat(newParameterName, "} is already used in the pipeline"));
848
900
  }
849
- var renamedPipeline = __assign(__assign({}, pipeline), { parameters: __spreadArray([], __read(pipeline.parameters), false), templates: __spreadArray([], __read(pipeline.templates), false) });
901
+ var renamedPipeline = __assign(__assign({}, pipeline), {
902
+ // <- TODO: [🪓] This should be without `as $PipelineJson`
903
+ parameters: __spreadArray([], __read(pipeline.parameters), false), templates: __spreadArray([], __read(pipeline.templates), false) });
850
904
  try {
851
905
  for (var _c = __values(renamedPipeline.parameters), _d = _c.next(); !_d.done; _d = _c.next()) {
852
906
  var parameter = _d.value;
@@ -1078,6 +1132,7 @@
1078
1132
  * @param options - Options for the function
1079
1133
  * @param callbackfunction - Function to call for each item
1080
1134
  * @public exported from `@promptbook/utils`
1135
+ * @deprecated [🪂] Use queues instead
1081
1136
  */
1082
1137
  function forEachAsync(array, options, callbackfunction) {
1083
1138
  return __awaiter(this, void 0, void 0, function () {
@@ -1347,10 +1402,6 @@
1347
1402
  charType = 'NUMBER';
1348
1403
  normalizedChar = char;
1349
1404
  }
1350
- else if (/^\/$/.test(char)) {
1351
- charType = 'SLASH';
1352
- normalizedChar = char;
1353
- }
1354
1405
  else {
1355
1406
  charType = 'OTHER';
1356
1407
  normalizedChar = '_';
@@ -1937,7 +1988,7 @@
1937
1988
  * Generates random seed
1938
1989
  *
1939
1990
  * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
1940
- * Warning: This function is not cryptographically secure (it uses Math.random internally)
1991
+ * Warning: This function is NOT cryptographically secure (it uses Math.random internally)
1941
1992
  * @public exported from `@promptbook/utils`
1942
1993
  */
1943
1994
  function $randomSeed() {
@@ -2285,32 +2336,6 @@
2285
2336
  return /^.+@.+\..+$/.test(email);
2286
2337
  }
2287
2338
 
2288
- /**
2289
- * Tests if given string is valid URL.
2290
- *
2291
- * Note: This does not check if the file exists only if the path is valid
2292
- * @public exported from `@promptbook/utils`
2293
- */
2294
- function isValidFilePath(filePath) {
2295
- if (typeof filePath !== 'string') {
2296
- return false;
2297
- }
2298
- var filePathSlashes = filePath.split('\\').join('/');
2299
- // Absolute Unix path: /hello.txt
2300
- if (/^(\/)/i.test(filePathSlashes)) {
2301
- return true;
2302
- }
2303
- // Absolute Windows path: /hello.txt
2304
- if (/^([A-Z]{1,2}:\/?)\//i.test(filePathSlashes)) {
2305
- return true;
2306
- }
2307
- // Relative path: ./hello.txt
2308
- if (/^(\.\.?\/)+/i.test(filePathSlashes)) {
2309
- return true;
2310
- }
2311
- return false;
2312
- }
2313
-
2314
2339
  /**
2315
2340
  * @@@
2316
2341
  *
@@ -2363,7 +2388,7 @@
2363
2388
  if ( /* version === '1.0.0' || */version === '2.0.0' || version === '3.0.0') {
2364
2389
  return false;
2365
2390
  }
2366
- // <- TODO:[main] !!! Check isValidPromptbookVersion against PROMPTBOOK_VERSIONS
2391
+ // <- TODO: [main] !!! Check isValidPromptbookVersion against PROMPTBOOK_VERSIONS
2367
2392
  return true;
2368
2393
  }
2369
2394
 
@@ -2418,35 +2443,6 @@
2418
2443
  return isHostnameOnPrivateNetwork(url.hostname);
2419
2444
  }
2420
2445
 
2421
- /**
2422
- * Tests if given string is valid URL.
2423
- *
2424
- * Note: Dataurl are considered perfectly valid.
2425
- * Note: There are two simmilar functions:
2426
- * - `isValidUrl` which tests any URL
2427
- * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
2428
- *
2429
- * @public exported from `@promptbook/utils`
2430
- */
2431
- function isValidUrl(url) {
2432
- if (typeof url !== 'string') {
2433
- return false;
2434
- }
2435
- try {
2436
- if (url.startsWith('blob:')) {
2437
- url = url.replace(/^blob:/, '');
2438
- }
2439
- var urlObject = new URL(url /* because fail is handled */);
2440
- if (!['http:', 'https:', 'data:'].includes(urlObject.protocol)) {
2441
- return false;
2442
- }
2443
- return true;
2444
- }
2445
- catch (error) {
2446
- return false;
2447
- }
2448
- }
2449
-
2450
2446
  /**
2451
2447
  * Tests if given string is valid pipeline URL URL.
2452
2448
  *