@promptbook/node 0.71.0-0 → 0.71.0-7

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 (131) hide show
  1. package/README.md +6 -0
  2. package/esm/index.es.js +2797 -1654
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/src/_packages/browser.index.d.ts +1 -1
  5. package/esm/typings/src/_packages/core.index.d.ts +28 -10
  6. package/esm/typings/src/_packages/node.index.d.ts +6 -2
  7. package/esm/typings/src/_packages/types.index.d.ts +28 -20
  8. package/esm/typings/src/cli/cli-commands/about.d.ts +1 -1
  9. package/esm/typings/src/cli/cli-commands/hello.d.ts +1 -1
  10. package/esm/typings/src/cli/cli-commands/make.d.ts +1 -1
  11. package/esm/typings/src/cli/cli-commands/prettify.d.ts +1 -1
  12. package/esm/typings/src/cli/main.d.ts +1 -1
  13. package/esm/typings/src/cli/promptbookCli.d.ts +1 -1
  14. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +8 -5
  15. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +1 -1
  16. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +1 -1
  17. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +5 -1
  18. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +1 -1
  19. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +1 -1
  20. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +1 -1
  21. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +1 -1
  22. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.d.ts +11 -0
  23. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.test.d.ts +4 -0
  24. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +1 -1
  25. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +1 -1
  26. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +1 -1
  27. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +1 -1
  28. package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +1 -1
  29. package/esm/typings/src/commands/TEMPLATE/templateCommandParser.d.ts +1 -1
  30. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +1 -1
  31. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +1 -1
  32. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +1 -1
  33. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -1
  34. package/esm/typings/src/config.d.ts +10 -0
  35. package/esm/typings/src/conversion/pipelineStringToJson.d.ts +2 -15
  36. package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +1 -1
  37. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +1 -1
  38. package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceTools.d.ts +2 -2
  39. package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceToolsOptions.d.ts +2 -2
  40. package/esm/typings/src/{knowledge/dialogs → dialogs}/simple-prompt/SimplePromptInterfaceTools.d.ts +4 -4
  41. package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
  42. package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
  43. package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
  44. package/esm/typings/src/execution/ExecutionTools.d.ts +3 -3
  45. package/esm/typings/src/execution/PipelineExecutor.d.ts +1 -0
  46. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +5 -2
  47. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts +2 -13
  48. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +3 -0
  49. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +4 -1
  50. package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts +3 -0
  51. package/esm/typings/src/execution/createPipelineExecutor/{30-executeFormatCells.d.ts → 30-executeFormatSubvalues.d.ts} +2 -6
  52. package/esm/typings/src/execution/embeddingVectorToString.d.ts +1 -1
  53. package/esm/typings/src/execution/utils/forEachAsync.d.ts +1 -0
  54. package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +2 -1
  55. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  56. package/esm/typings/src/llm-providers/_common/createLlmToolsFromConfigurationFromEnv.d.ts +1 -1
  57. package/esm/typings/src/llm-providers/_common/createLlmToolsFromEnv.d.ts +1 -1
  58. package/esm/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts +1 -1
  59. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +2 -1
  60. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +3 -2
  61. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +8 -1
  62. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +1 -0
  63. package/esm/typings/src/llm-providers/langtail/playground/playground.d.ts +3 -0
  64. package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts +3 -0
  65. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +2 -1
  66. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +2 -1
  67. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +3 -0
  68. package/esm/typings/src/personas/preparePersona.d.ts +2 -2
  69. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +67 -0
  70. package/esm/typings/src/prepare/preparePipeline.d.ts +2 -2
  71. package/esm/typings/src/prepare/prepareTemplates.d.ts +2 -2
  72. package/esm/typings/src/scrapers/_common/Converter.d.ts +28 -0
  73. package/esm/typings/src/scrapers/_common/Scraper.d.ts +71 -0
  74. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +11 -0
  75. package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.d.ts +4 -4
  76. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +33 -0
  77. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  78. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +10 -0
  79. package/esm/typings/src/scrapers/document/documentScraper.d.ts +37 -0
  80. package/esm/typings/src/scrapers/document/documentScraper.test.d.ts +4 -0
  81. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  82. package/esm/typings/src/scrapers/document-legacy/legacyDocumentScraper.d.ts +37 -0
  83. package/esm/typings/src/scrapers/document-legacy/legacyDocumentScraper.test.d.ts +4 -0
  84. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  85. package/esm/typings/src/scrapers/index.d.ts +7 -0
  86. package/esm/typings/src/scrapers/markdown/markdownScraper.d.ts +29 -0
  87. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  88. package/esm/typings/src/scrapers/pdf/pdfScraper.d.ts +35 -0
  89. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  90. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  91. package/esm/typings/src/scrapers/website/utils/markdownConverter.d.ts +12 -0
  92. package/esm/typings/src/scrapers/website/websiteScraper.d.ts +43 -0
  93. package/esm/typings/src/storage/{files-storage/FilesStorage.d.ts → file-cache-storage/FileCacheStorage.d.ts} +4 -4
  94. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +10 -0
  95. package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.d.ts +1 -1
  96. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts +1 -0
  97. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +1 -1
  98. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +1 -1
  99. package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts +1 -1
  100. package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +2 -2
  101. package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts +0 -3
  102. package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts +2 -1
  103. package/esm/typings/src/types/typeAliases.d.ts +9 -12
  104. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +14 -0
  105. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +17 -0
  106. package/esm/typings/src/utils/execCommand/IExecCommandOptions.d.ts +23 -0
  107. package/esm/typings/src/utils/execCommand/execCommand.test.d.ts +1 -0
  108. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts +10 -0
  109. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts +1 -0
  110. package/esm/typings/src/utils/files/$isDirectoryExisting.d.ts +3 -3
  111. package/esm/typings/src/utils/files/$isFileExisting.d.ts +3 -3
  112. package/esm/typings/src/utils/files/$listAllFiles.d.ts +4 -4
  113. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  114. package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts +1 -0
  115. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  116. package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
  117. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +2 -2
  118. package/package.json +6 -2
  119. package/umd/index.umd.js +2798 -1658
  120. package/umd/index.umd.js.map +1 -1
  121. package/esm/typings/src/knowledge/prepare-knowledge/_common/Scraper.d.ts +0 -37
  122. package/esm/typings/src/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts +0 -2
  123. package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +0 -14
  124. package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +0 -15
  125. package/esm/typings/src/prepare/PrepareOptions.d.ts +0 -22
  126. package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts +0 -10
  127. /package/esm/typings/src/{knowledge/dialogs → dialogs}/user-interface-execution-tools.test.d.ts +0 -0
  128. /package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.test.d.ts +0 -0
  129. /package/esm/typings/src/{knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts → scrapers/markdown/markdownScraper.test.d.ts} +0 -0
  130. /package/esm/typings/src/{knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts → scrapers/website/utils/markdownConverter.test.d.ts} +0 -0
  131. /package/esm/typings/src/{storage/files-storage/utils/nameToSubfolderPath.test.d.ts → scrapers/website/websiteScraper.test.d.ts} +0 -0
@@ -1,5 +1,5 @@
1
1
  import { PROMPTBOOK_VERSION } from '../version';
2
- import { SimplePromptInterfaceTools } from '../knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools';
2
+ import { SimplePromptInterfaceTools } from '../dialogs/simple-prompt/SimplePromptInterfaceTools';
3
3
  import { getLocalStorage } from '../storage/local-storage/getLocalStorage';
4
4
  import { getSessionStorage } from '../storage/local-storage/getSessionStorage';
5
5
  export { PROMPTBOOK_VERSION };
@@ -13,6 +13,7 @@ import { MAX_FILENAME_LENGTH } from '../config';
13
13
  import { MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH } from '../config';
14
14
  import { MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL } from '../config';
15
15
  import { EXECUTIONS_CACHE_DIRNAME } from '../config';
16
+ import { SCRAPE_CACHE_DIRNAME } from '../config';
16
17
  import { PIPELINE_COLLECTION_BASE_FILENAME } from '../config';
17
18
  import { RESERVED_PARAMETER_NAMES } from '../config';
18
19
  import { DEFAULT_REMOTE_URL } from '../config';
@@ -20,17 +21,21 @@ import { DEFAULT_REMOTE_URL_PATH } from '../config';
20
21
  import { DEFAULT_CSV_SETTINGS } from '../config';
21
22
  import { IS_VERBOSE } from '../config';
22
23
  import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
23
- import type { PipelineStringToJsonOptions } from '../conversion/pipelineStringToJson';
24
24
  import { pipelineStringToJson } from '../conversion/pipelineStringToJson';
25
25
  import { pipelineStringToJsonSync } from '../conversion/pipelineStringToJsonSync';
26
26
  import { prettifyPipelineString } from '../conversion/prettify/prettifyPipelineString';
27
27
  import { stringifyPipelineJson } from '../conversion/utils/stringifyPipelineJson';
28
28
  import { validatePipeline } from '../conversion/validation/validatePipeline';
29
+ import { CallbackInterfaceTools } from '../dialogs/callback/CallbackInterfaceTools';
30
+ import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';
31
+ import { AbstractFormatError } from '../errors/AbstractFormatError';
29
32
  import { CollectionError } from '../errors/CollectionError';
30
33
  import { EnvironmentMismatchError } from '../errors/EnvironmentMismatchError';
31
34
  import { ExpectError } from '../errors/ExpectError';
32
35
  import { ERRORS } from '../errors/index';
36
+ import { KnowledgeScrapeError } from '../errors/KnowledgeScrapeError';
33
37
  import { LimitReachedError } from '../errors/LimitReachedError';
38
+ import { MissingToolsError } from '../errors/MissingToolsError';
34
39
  import { NotFoundError } from '../errors/NotFoundError';
35
40
  import { NotYetImplementedError } from '../errors/NotYetImplementedError';
36
41
  import { ParseError } from '../errors/ParseError';
@@ -47,12 +52,9 @@ import { isPassingExpectations } from '../execution/utils/checkExpectations';
47
52
  import { usageToHuman } from '../execution/utils/usageToHuman';
48
53
  import { usageToWorktime } from '../execution/utils/usageToWorktime';
49
54
  import { CsvFormatDefinition } from '../formats/csv/CsvFormatDefinition';
55
+ import { CsvFormatError } from '../formats/csv/CsvFormatError';
50
56
  import { MANDATORY_CSV_SETTINGS } from '../formats/csv/CsvSettings';
51
57
  import { TextFormatDefinition } from '../formats/text/TextFormatDefinition';
52
- import { CallbackInterfaceTools } from '../knowledge/dialogs/callback/CallbackInterfaceTools';
53
- import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
54
- import { prepareKnowledgePieces } from '../knowledge/prepare-knowledge/_common/prepareKnowledgePieces';
55
- import { prepareKnowledgeFromMarkdown } from '../knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown';
56
58
  import { $llmToolsMetadataRegister } from '../llm-providers/_common/$llmToolsMetadataRegister';
57
59
  import { $llmToolsRegister } from '../llm-providers/_common/$llmToolsRegister';
58
60
  import { createLlmToolsFromConfiguration } from '../llm-providers/_common/createLlmToolsFromConfiguration';
@@ -68,6 +70,13 @@ import { isPipelinePrepared } from '../prepare/isPipelinePrepared';
68
70
  import { preparePipeline } from '../prepare/preparePipeline';
69
71
  import { prepareTemplates } from '../prepare/prepareTemplates';
70
72
  import { unpreparePipeline } from '../prepare/unpreparePipeline';
73
+ import { prepareKnowledgePieces } from '../scrapers/_common/prepareKnowledgePieces';
74
+ import { legacyDocumentScraper } from '../scrapers/document-legacy/legacyDocumentScraper';
75
+ import { documentScraper } from '../scrapers/document/documentScraper';
76
+ import { SCRAPERS } from '../scrapers/index';
77
+ import { markdownScraper } from '../scrapers/markdown/markdownScraper';
78
+ import { pdfScraper } from '../scrapers/pdf/pdfScraper';
79
+ import { websiteScraper } from '../scrapers/website/websiteScraper';
71
80
  import { MemoryStorage } from '../storage/memory/MemoryStorage';
72
81
  import { PrefixStorage } from '../storage/utils/PrefixStorage';
73
82
  import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
@@ -90,6 +99,7 @@ export { MAX_FILENAME_LENGTH };
90
99
  export { MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH };
91
100
  export { MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL };
92
101
  export { EXECUTIONS_CACHE_DIRNAME };
102
+ export { SCRAPE_CACHE_DIRNAME };
93
103
  export { PIPELINE_COLLECTION_BASE_FILENAME };
94
104
  export { RESERVED_PARAMETER_NAMES };
95
105
  export { DEFAULT_REMOTE_URL };
@@ -97,17 +107,21 @@ export { DEFAULT_REMOTE_URL_PATH };
97
107
  export { DEFAULT_CSV_SETTINGS };
98
108
  export { IS_VERBOSE };
99
109
  export { pipelineJsonToString };
100
- export type { PipelineStringToJsonOptions };
101
110
  export { pipelineStringToJson };
102
111
  export { pipelineStringToJsonSync };
103
112
  export { prettifyPipelineString };
104
113
  export { stringifyPipelineJson };
105
114
  export { validatePipeline };
115
+ export { CallbackInterfaceTools };
116
+ export type { CallbackInterfaceToolsOptions };
117
+ export { AbstractFormatError };
106
118
  export { CollectionError };
107
119
  export { EnvironmentMismatchError };
108
120
  export { ExpectError };
109
121
  export { ERRORS };
122
+ export { KnowledgeScrapeError };
110
123
  export { LimitReachedError };
124
+ export { MissingToolsError };
111
125
  export { NotFoundError };
112
126
  export { NotYetImplementedError };
113
127
  export { ParseError };
@@ -124,12 +138,9 @@ export { isPassingExpectations };
124
138
  export { usageToHuman };
125
139
  export { usageToWorktime };
126
140
  export { CsvFormatDefinition };
141
+ export { CsvFormatError };
127
142
  export { MANDATORY_CSV_SETTINGS };
128
143
  export { TextFormatDefinition };
129
- export { CallbackInterfaceTools };
130
- export type { CallbackInterfaceToolsOptions };
131
- export { prepareKnowledgePieces };
132
- export { prepareKnowledgeFromMarkdown };
133
144
  export { $llmToolsMetadataRegister };
134
145
  export { $llmToolsRegister };
135
146
  export { createLlmToolsFromConfiguration };
@@ -145,6 +156,13 @@ export { isPipelinePrepared };
145
156
  export { preparePipeline };
146
157
  export { prepareTemplates };
147
158
  export { unpreparePipeline };
159
+ export { prepareKnowledgePieces };
160
+ export { legacyDocumentScraper };
161
+ export { documentScraper };
162
+ export { SCRAPERS };
163
+ export { markdownScraper };
164
+ export { pdfScraper };
165
+ export { websiteScraper };
148
166
  export { MemoryStorage };
149
167
  export { PrefixStorage };
150
168
  export { executionReportJsonToString };
@@ -2,9 +2,13 @@ import { PROMPTBOOK_VERSION } from '../version';
2
2
  import { createCollectionFromDirectory } from '../collection/constructors/createCollectionFromDirectory';
3
3
  import { createLlmToolsFromConfigurationFromEnv } from '../llm-providers/_common/createLlmToolsFromConfigurationFromEnv';
4
4
  import { createLlmToolsFromEnv } from '../llm-providers/_common/createLlmToolsFromEnv';
5
- import { FilesStorage } from '../storage/files-storage/FilesStorage';
5
+ import { FileCacheStorage } from '../storage/file-cache-storage/FileCacheStorage';
6
+ import { $execCommand } from '../utils/execCommand/$execCommand';
7
+ import { $execCommands } from '../utils/execCommand/$execCommands';
6
8
  export { PROMPTBOOK_VERSION };
7
9
  export { createCollectionFromDirectory };
8
10
  export { createLlmToolsFromConfigurationFromEnv };
9
11
  export { createLlmToolsFromEnv };
10
- export { FilesStorage };
12
+ export { FileCacheStorage };
13
+ export { $execCommand };
14
+ export { $execCommands };
@@ -10,9 +10,9 @@ import type { ExpectCommand } from '../commands/EXPECT/ExpectCommand';
10
10
  import type { ForeachJson } from '../commands/FOREACH/ForeachJson';
11
11
  import type { FormatCommand } from '../commands/FORMAT/FormatCommand';
12
12
  import type { TemplateType } from '../commands/TEMPLATE/TemplateTypes';
13
- import type { PipelineStringToJsonOptions } from '../conversion/pipelineStringToJson';
14
13
  import type { PrettifyOptions } from '../conversion/prettify/PrettifyOptions';
15
14
  import type { renderPipelineMermaidOptions } from '../conversion/prettify/renderPipelineMermaidOptions';
15
+ import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';
16
16
  import type { ErrorJson } from '../errors/utils/ErrorJson';
17
17
  import type { AvailableModel } from '../execution/AvailableModel';
18
18
  import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
@@ -37,7 +37,6 @@ import type { UserInterfaceTools } from '../execution/UserInterfaceTools';
37
37
  import type { UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
38
38
  import type { FormatSubvalueDefinition } from '../formats/_common/FormatSubvalueDefinition';
39
39
  import type { CsvSettings } from '../formats/csv/CsvSettings';
40
- import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
41
40
  import type { LlmToolsConfiguration } from '../llm-providers/_common/LlmToolsConfiguration';
42
41
  import type { LlmToolsMetadata } from '../llm-providers/_common/LlmToolsMetadata';
43
42
  import type { LlmToolsOptions } from '../llm-providers/_common/LlmToolsOptions';
@@ -65,11 +64,15 @@ import type { RemoteLlmExecutionToolsOptions } from '../llm-providers/remote/int
65
64
  import type { RemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
66
65
  import type { AnonymousRemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
67
66
  import type { CollectionRemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
68
- import type { PrepareOptions } from '../prepare/PrepareOptions';
67
+ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
68
+ import type { Converter } from '../scrapers/_common/Converter';
69
+ import type { Scraper } from '../scrapers/_common/Scraper';
70
+ import type { ScraperSourceHandler } from '../scrapers/_common/Scraper';
71
+ import type { ScraperIntermediateSource } from '../scrapers/_common/ScraperIntermediateSource';
69
72
  import type { JavascriptExecutionToolsOptions } from '../scripting/javascript/JavascriptExecutionToolsOptions';
70
73
  import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
71
74
  import type { PromptbookStorage } from '../storage/_common/PromptbookStorage';
72
- import type { FilesStorageOptions } from '../storage/files-storage/FilesStorageOptions';
75
+ import type { FileCacheStorageOptions } from '../storage/file-cache-storage/FileCacheStorageOptions';
73
76
  import type { ExecutionPromptReportJson } from '../types/execution-report/ExecutionPromptReportJson';
74
77
  import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
75
78
  import type { ExecutionReportString } from '../types/execution-report/ExecutionReportString';
@@ -166,13 +169,12 @@ import type { string_sha256 } from '../types/typeAliases';
166
169
  import type { string_semantic_version } from '../types/typeAliases';
167
170
  import type { string_version_dependency } from '../types/typeAliases';
168
171
  import type { string_file_extension } from '../types/typeAliases';
169
- import type { string_file_absolute_path } from '../types/typeAliases';
170
- import type { string_file_relative_path } from '../types/typeAliases';
171
- import type { string_file_path } from '../types/typeAliases';
172
- import type { string_folder_absolute_path } from '../types/typeAliases';
173
- import type { string_folder_relative_path } from '../types/typeAliases';
174
- import type { string_folder_path } from '../types/typeAliases';
172
+ import type { string_absolute_filename } from '../types/typeAliases';
173
+ import type { string_relative_filename } from '../types/typeAliases';
175
174
  import type { string_filename } from '../types/typeAliases';
175
+ import type { string_absolute_dirname } from '../types/typeAliases';
176
+ import type { string_relative_dirname } from '../types/typeAliases';
177
+ import type { string_dirname } from '../types/typeAliases';
176
178
  import type { string_person_fullname } from '../types/typeAliases';
177
179
  import type { string_person_profile } from '../types/typeAliases';
178
180
  import type { string_license } from '../types/typeAliases';
@@ -215,6 +217,8 @@ import type { number_megabytes } from '../types/typeAliases';
215
217
  import type { number_gigabytes } from '../types/typeAliases';
216
218
  import type { number_terabytes } from '../types/typeAliases';
217
219
  import type { Registered } from '../utils/$Register';
220
+ import type { IExecCommandOptions } from '../utils/execCommand/IExecCommandOptions';
221
+ import type { IExecCommandOptionsAdvanced } from '../utils/execCommand/IExecCommandOptions';
218
222
  import type { FromtoItems } from '../utils/FromtoItems';
219
223
  import type { CodeBlock } from '../utils/markdown/extractAllBlocksFromMarkdown';
220
224
  import type { MarkdownSection } from '../utils/markdown/parseMarkdownSection';
@@ -241,9 +245,9 @@ export type { ExpectCommand };
241
245
  export type { ForeachJson };
242
246
  export type { FormatCommand };
243
247
  export type { TemplateType };
244
- export type { PipelineStringToJsonOptions };
245
248
  export type { PrettifyOptions };
246
249
  export type { renderPipelineMermaidOptions };
250
+ export type { CallbackInterfaceToolsOptions };
247
251
  export type { ErrorJson };
248
252
  export type { AvailableModel };
249
253
  export type { CommonExecutionToolsOptions };
@@ -268,7 +272,6 @@ export type { UserInterfaceTools };
268
272
  export type { UserInterfaceToolsPromptDialogOptions };
269
273
  export type { FormatSubvalueDefinition };
270
274
  export type { CsvSettings };
271
- export type { CallbackInterfaceToolsOptions };
272
275
  export type { LlmToolsConfiguration };
273
276
  export type { LlmToolsMetadata };
274
277
  export type { LlmToolsOptions };
@@ -296,11 +299,15 @@ export type { RemoteLlmExecutionToolsOptions };
296
299
  export type { RemoteServerOptions };
297
300
  export type { AnonymousRemoteServerOptions };
298
301
  export type { CollectionRemoteServerOptions };
299
- export type { PrepareOptions };
302
+ export type { PrepareAndScrapeOptions };
303
+ export type { Converter };
304
+ export type { Scraper };
305
+ export type { ScraperSourceHandler };
306
+ export type { ScraperIntermediateSource };
300
307
  export type { JavascriptExecutionToolsOptions };
301
308
  export type { PostprocessingFunction };
302
309
  export type { PromptbookStorage };
303
- export type { FilesStorageOptions };
310
+ export type { FileCacheStorageOptions };
304
311
  export type { ExecutionPromptReportJson };
305
312
  export type { ExecutionReportJson };
306
313
  export type { ExecutionReportString };
@@ -397,13 +404,12 @@ export type { string_sha256 };
397
404
  export type { string_semantic_version };
398
405
  export type { string_version_dependency };
399
406
  export type { string_file_extension };
400
- export type { string_file_absolute_path };
401
- export type { string_file_relative_path };
402
- export type { string_file_path };
403
- export type { string_folder_absolute_path };
404
- export type { string_folder_relative_path };
405
- export type { string_folder_path };
407
+ export type { string_absolute_filename };
408
+ export type { string_relative_filename };
406
409
  export type { string_filename };
410
+ export type { string_absolute_dirname };
411
+ export type { string_relative_dirname };
412
+ export type { string_dirname };
407
413
  export type { string_person_fullname };
408
414
  export type { string_person_profile };
409
415
  export type { string_license };
@@ -446,6 +452,8 @@ export type { number_megabytes };
446
452
  export type { number_gigabytes };
447
453
  export type { number_terabytes };
448
454
  export type { Registered };
455
+ export type { IExecCommandOptions };
456
+ export type { IExecCommandOptionsAdvanced };
449
457
  export type { FromtoItems };
450
458
  export type { CodeBlock };
451
459
  export type { MarkdownSection };
@@ -7,5 +7,5 @@ import type { Command as Program } from 'commander';
7
7
  export declare function initializeAboutCommand(program: Program): void;
8
8
  /**
9
9
  * TODO: [🗽] Unite branding and make single place for it
10
- * Note: [🟡] This code should never be published outside of `@promptbook/cli`
10
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
11
11
  */
@@ -6,5 +6,5 @@ import type { Command as Program } from 'commander';
6
6
  */
7
7
  export declare function initializeHelloCommand(program: Program): void;
8
8
  /**
9
- * Note: [🟡] This code should never be published outside of `@promptbook/cli`
9
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
10
10
  */
@@ -9,6 +9,6 @@ export declare function initializeMakeCommand(program: Program): void;
9
9
  * TODO: [🥃][main] !!! Allow `ptbk make` without configuring any llm tools
10
10
  * TODO: Maybe remove this command - "about" command should be enough?
11
11
  * TODO: [0] DRY Javascript and typescript - Maybe make ONLY typescript and for javascript just remove types
12
- * Note: [🟡] This code should never be published outside of `@promptbook/cli`
12
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
13
13
  * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
14
14
  */
@@ -6,6 +6,6 @@ import type { Command as Program } from 'commander';
6
6
  */
7
7
  export declare function initializePrettifyCommand(program: Program): void;
8
8
  /**
9
- * Note: [🟡] This code should never be published outside of `@promptbook/cli`
9
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
10
10
  * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
11
11
  */
@@ -8,5 +8,5 @@ export declare const _CLI: {
8
8
  _initialize: typeof promptbookCli;
9
9
  };
10
10
  /**
11
- * Note: [🟡] This code should never be published outside of `@promptbook/cli`
11
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
12
12
  */
@@ -8,5 +8,5 @@ export declare function promptbookCli(): Promise<void>;
8
8
  * TODO: [🥠] Do not export, its just for CLI script
9
9
  * TODO: [🕌] When more functionalities, rename
10
10
  * Note: 11:11
11
- * Note: [🟡] This code should never be published outside of `@promptbook/cli`
11
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
12
12
  */
@@ -1,10 +1,13 @@
1
- import type { PipelineStringToJsonOptions } from '../../conversion/pipelineStringToJson';
2
- import type { string_folder_path } from '../../types/typeAliases';
1
+ import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
2
+ import type { string_dirname } from '../../types/typeAliases';
3
3
  import type { PipelineCollection } from '../PipelineCollection';
4
4
  /**
5
5
  * Options for `createCollectionFromDirectory` function
6
+ *
7
+ * Note: `rootDirname` is not needed because it is the folder in which `.ptbk.md` file is located
8
+ * This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
6
9
  */
7
- type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions & {
10
+ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {
8
11
  /**
9
12
  * If true, the directory is searched recursively for pipelines
10
13
  *
@@ -41,9 +44,9 @@ type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions
41
44
  * @returns PipelineCollection
42
45
  * @public exported from `@promptbook/node`
43
46
  */
44
- export declare function createCollectionFromDirectory(path: string_folder_path, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
47
+ export declare function createCollectionFromDirectory(path: string_dirname, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
45
48
  export {};
46
49
  /**
47
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
50
+ * Note: [🟢] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
48
51
  * TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed
49
52
  */
@@ -25,5 +25,5 @@ type CreatePipelineCollectionFromUrlyOptions = {
25
25
  export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
26
26
  export {};
27
27
  /**
28
- * TODO:[main] !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
28
+ * TODO: [main] !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
29
29
  */
@@ -3,7 +3,7 @@ import type { ExpectCommand } from './ExpectCommand';
3
3
  /**
4
4
  * Parses the expect command
5
5
  *
6
- * @see ./EXPECT-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const expectCommandParser: PipelineTemplateCommandParser<ExpectCommand>;
@@ -19,5 +19,9 @@ export type ForeachJson = {
19
19
  /**
20
20
  * @@@
21
21
  */
22
- readonly subparameterNames: Array<string_parameter_name>;
22
+ readonly inputSubparameterNames: Array<string_parameter_name>;
23
+ /**
24
+ * @@@
25
+ */
26
+ readonly outputSubparameterName: string_parameter_name;
23
27
  };
@@ -5,7 +5,7 @@ import type { ForeachCommand } from './ForeachCommand';
5
5
  *
6
6
  * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.ptbk.md` file
7
7
  *
8
- * @see ./FOREACH-README.md for more details <- TODO: @@@ Write theese README files OR remove this link + add annotation here (to all commands)
8
+ * @see `documentationUrl` for more details
9
9
  * @private within the commands folder
10
10
  */
11
11
  export declare const foreachCommandParser: PipelineTemplateCommandParser<ForeachCommand>;
@@ -3,7 +3,7 @@ import type { FormatCommand } from './FormatCommand';
3
3
  /**
4
4
  * Parses the format command
5
5
  *
6
- * @see ./FORMAT-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const formatCommandParser: PipelineTemplateCommandParser<FormatCommand>;
@@ -3,7 +3,7 @@ import type { JokerCommand } from './JokerCommand';
3
3
  /**
4
4
  * Parses the joker command
5
5
  *
6
- * @see ./JOKER-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const jokerCommandParser: PipelineTemplateCommandParser<JokerCommand>;
@@ -3,7 +3,7 @@ import type { KnowledgeCommand } from './KnowledgeCommand';
3
3
  /**
4
4
  * Parses the knowledge command
5
5
  *
6
- * @see ./KNOWLEDGE-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const knowledgeCommandParser: PipelineHeadCommandParser<KnowledgeCommand>;
@@ -0,0 +1,11 @@
1
+ import type { string_knowledge_source_content } from '../../../types/typeAliases';
2
+ import type { string_name } from '../../../types/typeAliases';
3
+ /**
4
+ * Creates unique name for the source
5
+ *
6
+ * @private within the repository
7
+ */
8
+ export declare function sourceContentToName(sourceContent: string_knowledge_source_content): string_name;
9
+ /**
10
+ * TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
11
+ */
@@ -0,0 +1,4 @@
1
+ export {};
2
+ /**
3
+ * TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
4
+ */
@@ -3,7 +3,7 @@ import type { ModelCommand } from './ModelCommand';
3
3
  /**
4
4
  * Parses the model command
5
5
  *
6
- * @see ./MODEL-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const modelCommandParser: PipelineBothCommandParser<ModelCommand>;
@@ -3,7 +3,7 @@ import type { ParameterCommand } from './ParameterCommand';
3
3
  /**
4
4
  * Parses the parameter command
5
5
  *
6
- * @see ./PARAMETER-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const parameterCommandParser: PipelineBothCommandParser<ParameterCommand>;
@@ -3,7 +3,7 @@ import type { PersonaCommand } from './PersonaCommand';
3
3
  /**
4
4
  * Parses the persona command
5
5
  *
6
- * @see ./PERSONA-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const personaCommandParser: PipelineBothCommandParser<PersonaCommand>;
@@ -3,7 +3,7 @@ import type { PostprocessCommand } from './PostprocessCommand';
3
3
  /**
4
4
  * Parses the postprocess command
5
5
  *
6
- * @see ./POSTPROCESS-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const postprocessCommandParser: PipelineTemplateCommandParser<PostprocessCommand>;
@@ -3,7 +3,7 @@ import type { PromptbookVersionCommand } from './PromptbookVersionCommand';
3
3
  /**
4
4
  * Parses the PROMPTBOOK_VERSION command
5
5
  *
6
- * @see ./PROMPTBOOK_VERSION-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const promptbookVersionCommandParser: PipelineHeadCommandParser<PromptbookVersionCommand>;
@@ -3,7 +3,7 @@ import type { TemplateCommand } from './TemplateCommand';
3
3
  /**
4
4
  * Parses the template command
5
5
  *
6
- * @see ./TEMPLATE-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const templateCommandParser: PipelineTemplateCommandParser<TemplateCommand>;
@@ -3,7 +3,7 @@ import type { UrlCommand } from './UrlCommand';
3
3
  /**
4
4
  * Parses the url command
5
5
  *
6
- * @see ./URL-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const urlCommandParser: PipelineHeadCommandParser<UrlCommand>;
@@ -3,7 +3,7 @@ import type { ActionCommand } from './ActionCommand';
3
3
  /**
4
4
  * Parses the action command
5
5
  *
6
- * @see ./ACTION-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const actionCommandParser: PipelineHeadCommandParser<ActionCommand>;
@@ -3,7 +3,7 @@ import type { InstrumentCommand } from './InstrumentCommand';
3
3
  /**
4
4
  * Parses the instrument command
5
5
  *
6
- * @see ./INSTRUMENT-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const instrumentCommandParser: PipelineHeadCommandParser<InstrumentCommand>;
@@ -5,7 +5,7 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
5
5
  *
6
6
  * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.ptbk.md` file
7
7
  *
8
- * @see ./BOILERPLATE-README.md for more details <- TODO: @@@ Write theese README files OR remove this link + add annotation here (to all commands)
8
+ * @see `documentationUrl` for more details
9
9
  * @private within the commands folder
10
10
  */
11
11
  export declare const boilerplateCommandParser: PipelineBothCommandParser<BoilerplateCommand>;
@@ -84,9 +84,19 @@ export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
84
84
  /**
85
85
  * Where to store the cache of executions for promptbook CLI
86
86
  *
87
+ * Note: When the folder does not exist, it is created recursively
88
+ *
87
89
  * @public exported from `@promptbook/core`
88
90
  */
89
91
  export declare const EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-cache";
92
+ /**
93
+ * Where to store the scrape cache
94
+ *
95
+ * Note: When the folder does not exist, it is created recursively
96
+ *
97
+ * @public exported from `@promptbook/core`
98
+ */
99
+ export declare const SCRAPE_CACHE_DIRNAME = "/.promptbook/scrape-cache";
90
100
  /**
91
101
  * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
92
102
  *
@@ -1,19 +1,6 @@
1
- import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
1
+ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
2
2
  import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
3
3
  import type { PipelineString } from '../types/PipelineString';
4
- /**
5
- * Options for `pipelineStringToJson`
6
- *
7
- * @public exported from `@promptbook/core`
8
- */
9
- export type PipelineStringToJsonOptions = {
10
- /**
11
- * Tools for processing required for preparation of knowledge *(not for actual execution)*
12
- *
13
- * Note: If you provide `null`, the knowledge will not be prepared
14
- */
15
- readonly llmTools: LlmExecutionTools | null;
16
- };
17
4
  /**
18
5
  * Compile pipeline from string (markdown) format to JSON format
19
6
  *
@@ -31,7 +18,7 @@ export type PipelineStringToJsonOptions = {
31
18
  * @throws {ParseError} if the promptbook string is not valid
32
19
  * @public exported from `@promptbook/core`
33
20
  */
34
- export declare function pipelineStringToJson(pipelineString: PipelineString, options?: PipelineStringToJsonOptions): Promise<PipelineJson>;
21
+ export declare function pipelineStringToJson(pipelineString: PipelineString, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
35
22
  /**
36
23
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
37
24
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
@@ -18,7 +18,7 @@ import type { PipelineString } from '../types/PipelineString';
18
18
  */
19
19
  export declare function pipelineStringToJsonSync(pipelineString: PipelineString): PipelineJson;
20
20
  /**
21
- * TODO:[main] !!!! Warn if used only sync version
21
+ * TODO: [main] !!!! Warn if used only sync version
22
22
  * TODO: [🚞] Report here line/column of error
23
23
  * TODO: Use spaceTrim more effectively
24
24
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
@@ -25,5 +25,5 @@ export declare function importPipelineJson(path: `${string}.ptbk.json`): Pipelin
25
25
  */
26
26
  export declare function importPipelineJsonAsString(path: `${string}.ptbk.json`): string_json<PipelineJson>;
27
27
  /**
28
- * TODO: [🥯] This should be part of scripting + testing utilities set which are not builded into packages
28
+ * Note: [] Code in this file should never be published in any package
29
29
  */
@@ -1,5 +1,5 @@
1
- import type { UserInterfaceTools } from '../../../execution/UserInterfaceTools';
2
- import type { UserInterfaceToolsPromptDialogOptions } from '../../../execution/UserInterfaceTools';
1
+ import type { UserInterfaceTools } from '../../execution/UserInterfaceTools';
2
+ import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
3
3
  import type { CallbackInterfaceToolsOptions } from './CallbackInterfaceToolsOptions';
4
4
  /**
5
5
  * Delagates the user interaction to a async callback function