@promptbook/markdown-utils 0.75.0-2 → 0.75.1
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.
- package/README.md +46 -30
- package/esm/index.es.js +46 -46
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/core.index.d.ts +16 -4
- package/esm/typings/src/_packages/types.index.d.ts +8 -6
- package/esm/typings/src/_packages/utils.index.d.ts +2 -0
- package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts +1 -1
- package/esm/typings/src/commands/SECTION/SectionCommand.d.ts +1 -1
- package/esm/typings/src/commands/_common/types/CommandParser.d.ts +0 -2
- package/esm/typings/src/config.d.ts +34 -2
- package/esm/typings/src/conversion/pipelineJsonToString.d.ts +1 -1
- package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +2 -2
- package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.d.ts +3 -3
- package/esm/typings/src/conversion/utils/renameParameter.d.ts +2 -2
- package/esm/typings/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +1 -1
- package/esm/typings/src/execution/ScriptExecutionTools.d.ts +1 -1
- package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts +2 -2
- package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +3 -0
- package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts +32 -2
- package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts +14 -0
- package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts +2 -2
- package/esm/typings/src/formfactors/index.d.ts +72 -10
- package/esm/typings/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts +2 -2
- package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts +12 -2
- package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts +12 -2
- package/esm/typings/src/pipeline/PipelineInterface/PipelineInterface.d.ts +5 -4
- package/esm/typings/src/pipeline/PipelineInterface/constants.d.ts +2 -2
- package/esm/typings/src/pipeline/PipelineJson/{TaskJsonCommon.d.ts → CommonTaskJson.d.ts} +13 -13
- package/esm/typings/src/pipeline/PipelineJson/DialogTaskJson.d.ts +2 -2
- package/esm/typings/src/pipeline/PipelineJson/ParameterJson.d.ts +2 -0
- package/esm/typings/src/pipeline/PipelineJson/PersonaJson.d.ts +1 -1
- package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts +2 -2
- package/esm/typings/src/pipeline/PipelineJson/PromptTaskJson.d.ts +2 -2
- package/esm/typings/src/pipeline/PipelineJson/ScriptTaskJson.d.ts +2 -2
- package/esm/typings/src/pipeline/PipelineJson/SimpleTaskJson.d.ts +2 -2
- package/esm/typings/src/pipeline/PipelineJson/TaskJson.d.ts +1 -1
- package/esm/typings/src/pipeline/PipelineString.d.ts +1 -1
- package/esm/typings/src/prepare/isPipelinePrepared.d.ts +1 -1
- package/esm/typings/src/prepare/prepareTasks.d.ts +5 -5
- package/esm/typings/src/types/Prompt.d.ts +3 -3
- package/esm/typings/src/types/SectionType.d.ts +21 -0
- package/esm/typings/src/types/TaskProgress.d.ts +1 -1
- package/esm/typings/src/types/TaskType.d.ts +15 -0
- package/esm/typings/src/types/typeAliases.d.ts +1 -1
- package/esm/typings/src/utils/organization/TODO_remove_as.d.ts +6 -0
- package/esm/typings/src/utils/organization/spaceTrim.d.ts +11 -0
- package/esm/typings/src/utils/parameters/extractParameterNames.d.ts +1 -1
- package/esm/typings/src/version.d.ts +1 -1
- package/package.json +1 -1
- package/umd/index.umd.js +46 -46
- package/umd/index.umd.js.map +1 -1
- package/esm/typings/src/commands/SECTION/SectionType.d.ts +0 -13
- /package/esm/typings/{promptbook-collection → books}/index.d.ts +0 -0
|
@@ -4,9 +4,10 @@ import { createCollectionFromJson } from '../collection/constructors/createColle
|
|
|
4
4
|
import { createCollectionFromPromise } from '../collection/constructors/createCollectionFromPromise';
|
|
5
5
|
import { createCollectionFromUrl } from '../collection/constructors/createCollectionFromUrl';
|
|
6
6
|
import { createSubcollection } from '../collection/constructors/createSubcollection';
|
|
7
|
-
import
|
|
8
|
-
import { SectionTypes } from '../commands/SECTION/SectionType';
|
|
7
|
+
import { NAME } from '../config';
|
|
9
8
|
import { CLAIM } from '../config';
|
|
9
|
+
import { LOGO_LIGHT_SRC } from '../config';
|
|
10
|
+
import { LOGO_DARK_SRC } from '../config';
|
|
10
11
|
import { DEFAULT_TITLE } from '../config';
|
|
11
12
|
import { MAX_FILENAME_LENGTH } from '../config';
|
|
12
13
|
import { DEFAULT_INTERMEDIATE_FILES_STRATEGY } from '../config';
|
|
@@ -14,6 +15,7 @@ import { DEFAULT_MAX_PARALLEL_COUNT } from '../config';
|
|
|
14
15
|
import { DEFAULT_MAX_EXECUTION_ATTEMPTS } from '../config';
|
|
15
16
|
import { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH } from '../config';
|
|
16
17
|
import { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL } from '../config';
|
|
18
|
+
import { DEFAULT_BOOKS_DIRNAME } from '../config';
|
|
17
19
|
import { DEFAULT_EXECUTIONS_CACHE_DIRNAME } from '../config';
|
|
18
20
|
import { DEFAULT_SCRAPE_CACHE_DIRNAME } from '../config';
|
|
19
21
|
import { DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME } from '../config';
|
|
@@ -64,6 +66,7 @@ import { MANDATORY_CSV_SETTINGS } from '../formats/csv/CsvSettings';
|
|
|
64
66
|
import { TextFormatDefinition } from '../formats/text/TextFormatDefinition';
|
|
65
67
|
import { BoilerplateFormfactorDefinition } from '../formfactors/_boilerplate/BoilerplateFormfactorDefinition';
|
|
66
68
|
import { ChatbotFormfactorDefinition } from '../formfactors/chatbot/ChatbotFormfactorDefinition';
|
|
69
|
+
import { GeneratorFormfactorDefinition } from '../formfactors/generator/GeneratorFormfactorDefinition';
|
|
67
70
|
import { GenericFormfactorDefinition } from '../formfactors/generic/GenericFormfactorDefinition';
|
|
68
71
|
import { FORMFACTOR_DEFINITIONS } from '../formfactors/index';
|
|
69
72
|
import { MatcherFormfactorDefinition } from '../formfactors/matcher/MatcherFormfactorDefinition';
|
|
@@ -104,15 +107,19 @@ import { BlackholeStorage } from '../storage/blackhole/BlackholeStorage';
|
|
|
104
107
|
import { MemoryStorage } from '../storage/memory/MemoryStorage';
|
|
105
108
|
import { PrefixStorage } from '../storage/utils/PrefixStorage';
|
|
106
109
|
import { MODEL_VARIANTS } from '../types/ModelVariant';
|
|
110
|
+
import { NonTaskSectionTypes } from '../types/SectionType';
|
|
111
|
+
import { SectionTypes } from '../types/SectionType';
|
|
112
|
+
import { TaskTypes } from '../types/TaskType';
|
|
107
113
|
export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
|
|
108
114
|
export { collectionToJson };
|
|
109
115
|
export { createCollectionFromJson };
|
|
110
116
|
export { createCollectionFromPromise };
|
|
111
117
|
export { createCollectionFromUrl };
|
|
112
118
|
export { createSubcollection };
|
|
113
|
-
export
|
|
114
|
-
export { SectionTypes };
|
|
119
|
+
export { NAME };
|
|
115
120
|
export { CLAIM };
|
|
121
|
+
export { LOGO_LIGHT_SRC };
|
|
122
|
+
export { LOGO_DARK_SRC };
|
|
116
123
|
export { DEFAULT_TITLE };
|
|
117
124
|
export { MAX_FILENAME_LENGTH };
|
|
118
125
|
export { DEFAULT_INTERMEDIATE_FILES_STRATEGY };
|
|
@@ -120,6 +127,7 @@ export { DEFAULT_MAX_PARALLEL_COUNT };
|
|
|
120
127
|
export { DEFAULT_MAX_EXECUTION_ATTEMPTS };
|
|
121
128
|
export { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH };
|
|
122
129
|
export { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL };
|
|
130
|
+
export { DEFAULT_BOOKS_DIRNAME };
|
|
123
131
|
export { DEFAULT_EXECUTIONS_CACHE_DIRNAME };
|
|
124
132
|
export { DEFAULT_SCRAPE_CACHE_DIRNAME };
|
|
125
133
|
export { DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME };
|
|
@@ -170,6 +178,7 @@ export { MANDATORY_CSV_SETTINGS };
|
|
|
170
178
|
export { TextFormatDefinition };
|
|
171
179
|
export { BoilerplateFormfactorDefinition };
|
|
172
180
|
export { ChatbotFormfactorDefinition };
|
|
181
|
+
export { GeneratorFormfactorDefinition };
|
|
173
182
|
export { GenericFormfactorDefinition };
|
|
174
183
|
export { FORMFACTOR_DEFINITIONS };
|
|
175
184
|
export { MatcherFormfactorDefinition };
|
|
@@ -210,3 +219,6 @@ export { BlackholeStorage };
|
|
|
210
219
|
export { MemoryStorage };
|
|
211
220
|
export { PrefixStorage };
|
|
212
221
|
export { MODEL_VARIANTS };
|
|
222
|
+
export { NonTaskSectionTypes };
|
|
223
|
+
export { SectionTypes };
|
|
224
|
+
export { TaskTypes };
|
|
@@ -9,7 +9,6 @@ import type { CommandUsagePlace } from '../commands/_common/types/CommandUsagePl
|
|
|
9
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
|
-
import type { SectionType } from '../commands/SECTION/SectionType';
|
|
13
12
|
import type { PrettifyOptions } from '../conversion/prettify/PrettifyOptions';
|
|
14
13
|
import type { renderPipelineMermaidOptions } from '../conversion/prettify/renderPipelineMermaidOptions';
|
|
15
14
|
import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';
|
|
@@ -76,6 +75,7 @@ import type { CollectionRemoteServerOptions } from '../llm-providers/remote/inte
|
|
|
76
75
|
import type { CollectionRemoteServerClientOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
|
|
77
76
|
import type { IsPipelineImplementingInterfaceOptions } from '../pipeline/PipelineInterface/isPipelineImplementingInterface';
|
|
78
77
|
import type { PipelineInterface } from '../pipeline/PipelineInterface/PipelineInterface';
|
|
78
|
+
import type { CommonTaskJson } from '../pipeline/PipelineJson/CommonTaskJson';
|
|
79
79
|
import type { DialogTaskJson } from '../pipeline/PipelineJson/DialogTaskJson';
|
|
80
80
|
import type { Expectations } from '../pipeline/PipelineJson/Expectations';
|
|
81
81
|
import type { ExpectationUnit } from '../pipeline/PipelineJson/Expectations';
|
|
@@ -96,7 +96,6 @@ import type { PromptTaskJson } from '../pipeline/PipelineJson/PromptTaskJson';
|
|
|
96
96
|
import type { ScriptTaskJson } from '../pipeline/PipelineJson/ScriptTaskJson';
|
|
97
97
|
import type { SimpleTaskJson } from '../pipeline/PipelineJson/SimpleTaskJson';
|
|
98
98
|
import type { TaskJson } from '../pipeline/PipelineJson/TaskJson';
|
|
99
|
-
import type { TaskJsonCommon } from '../pipeline/PipelineJson/TaskJsonCommon';
|
|
100
99
|
import type { PipelineString } from '../pipeline/PipelineString';
|
|
101
100
|
import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
|
|
102
101
|
import type { Converter } from '../scrapers/_common/Converter';
|
|
@@ -120,7 +119,9 @@ import type { CompletionPrompt } from '../types/Prompt';
|
|
|
120
119
|
import type { ChatPrompt } from '../types/Prompt';
|
|
121
120
|
import type { EmbeddingPrompt } from '../types/Prompt';
|
|
122
121
|
import type { ScriptLanguage } from '../types/ScriptLanguage';
|
|
122
|
+
import type { SectionType } from '../types/SectionType';
|
|
123
123
|
import type { TaskProgress } from '../types/TaskProgress';
|
|
124
|
+
import type { TaskType } from '../types/TaskType';
|
|
124
125
|
import type { string_char_emoji } from '../types/typeAliasEmoji';
|
|
125
126
|
import type { string_business_category_name } from '../types/typeAliases';
|
|
126
127
|
import type { string_model_name } from '../types/typeAliases';
|
|
@@ -165,7 +166,7 @@ import type { string_css_selector } from '../types/typeAliases';
|
|
|
165
166
|
import type { string_url } from '../types/typeAliases';
|
|
166
167
|
import type { string_base_url } from '../types/typeAliases';
|
|
167
168
|
import type { string_pipeline_url } from '../types/typeAliases';
|
|
168
|
-
import type {
|
|
169
|
+
import type { string_pipeline_url_with_task_hash } from '../types/typeAliases';
|
|
169
170
|
import type { string_data_url } from '../types/typeAliases';
|
|
170
171
|
import type { string_base64 } from '../types/typeAliases';
|
|
171
172
|
import type { string_href } from '../types/typeAliases';
|
|
@@ -262,7 +263,6 @@ export type { CommandUsagePlace };
|
|
|
262
263
|
export type { ExpectCommand };
|
|
263
264
|
export type { ForeachJson };
|
|
264
265
|
export type { FormatCommand };
|
|
265
|
-
export type { SectionType };
|
|
266
266
|
export type { PrettifyOptions };
|
|
267
267
|
export type { renderPipelineMermaidOptions };
|
|
268
268
|
export type { CallbackInterfaceToolsOptions };
|
|
@@ -329,6 +329,7 @@ export type { CollectionRemoteServerOptions };
|
|
|
329
329
|
export type { CollectionRemoteServerClientOptions };
|
|
330
330
|
export type { IsPipelineImplementingInterfaceOptions };
|
|
331
331
|
export type { PipelineInterface };
|
|
332
|
+
export type { CommonTaskJson };
|
|
332
333
|
export type { DialogTaskJson };
|
|
333
334
|
export type { Expectations };
|
|
334
335
|
export type { ExpectationUnit };
|
|
@@ -349,7 +350,6 @@ export type { PromptTaskJson };
|
|
|
349
350
|
export type { ScriptTaskJson };
|
|
350
351
|
export type { SimpleTaskJson };
|
|
351
352
|
export type { TaskJson };
|
|
352
|
-
export type { TaskJsonCommon };
|
|
353
353
|
export type { PipelineString };
|
|
354
354
|
export type { PrepareAndScrapeOptions };
|
|
355
355
|
export type { Converter };
|
|
@@ -373,7 +373,9 @@ export type { CompletionPrompt };
|
|
|
373
373
|
export type { ChatPrompt };
|
|
374
374
|
export type { EmbeddingPrompt };
|
|
375
375
|
export type { ScriptLanguage };
|
|
376
|
+
export type { SectionType };
|
|
376
377
|
export type { TaskProgress };
|
|
378
|
+
export type { TaskType };
|
|
377
379
|
export type { string_char_emoji };
|
|
378
380
|
export type { string_business_category_name };
|
|
379
381
|
export type { string_model_name };
|
|
@@ -418,7 +420,7 @@ export type { string_css_selector };
|
|
|
418
420
|
export type { string_url };
|
|
419
421
|
export type { string_base_url };
|
|
420
422
|
export type { string_pipeline_url };
|
|
421
|
-
export type {
|
|
423
|
+
export type { string_pipeline_url_with_task_hash };
|
|
422
424
|
export type { string_data_url };
|
|
423
425
|
export type { string_base64 };
|
|
424
426
|
export type { string_href };
|
|
@@ -44,6 +44,7 @@ import { parseKeywords } from '../utils/normalization/parseKeywords';
|
|
|
44
44
|
import { parseKeywordsFromString } from '../utils/normalization/parseKeywordsFromString';
|
|
45
45
|
import { removeDiacritics } from '../utils/normalization/removeDiacritics';
|
|
46
46
|
import { searchKeywords } from '../utils/normalization/searchKeywords';
|
|
47
|
+
import { spaceTrim } from '../utils/organization/spaceTrim';
|
|
47
48
|
import { extractParameterNames } from '../utils/parameters/extractParameterNames';
|
|
48
49
|
import { replaceParameters } from '../utils/parameters/replaceParameters';
|
|
49
50
|
import { parseNumber } from '../utils/parseNumber';
|
|
@@ -117,6 +118,7 @@ export { parseKeywords };
|
|
|
117
118
|
export { parseKeywordsFromString };
|
|
118
119
|
export { removeDiacritics };
|
|
119
120
|
export { searchKeywords };
|
|
121
|
+
export { spaceTrim };
|
|
120
122
|
export { extractParameterNames };
|
|
121
123
|
export { replaceParameters };
|
|
122
124
|
export { parseNumber };
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations';
|
|
2
2
|
import type { ExpectationUnit } from '../../pipeline/PipelineJson/Expectations';
|
|
3
3
|
/**
|
|
4
|
-
* Expect amount command describes the desired output of the
|
|
4
|
+
* Expect amount command describes the desired output of the task (after post-processing)
|
|
5
5
|
* It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
|
|
6
6
|
*
|
|
7
7
|
* Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
|
|
@@ -99,8 +99,6 @@ export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonComm
|
|
|
99
99
|
};
|
|
100
100
|
/**
|
|
101
101
|
* @@@
|
|
102
|
-
*
|
|
103
|
-
* TODO: !!!!!! Rename to PipelineTaskCommandParser, applyToTaskJson, TaskJson, isUsedInPipelineTask,...
|
|
104
102
|
*/
|
|
105
103
|
export type PipelineTaskCommandParser<TCommand extends CommandBase> = CommonCommandParser<TCommand> & {
|
|
106
104
|
/**
|
|
@@ -1,11 +1,20 @@
|
|
|
1
1
|
import type { CsvSettings } from './formats/csv/CsvSettings';
|
|
2
2
|
import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
|
|
3
|
+
import type { string_url_image } from './types/typeAliases';
|
|
3
4
|
/**
|
|
4
5
|
* Warning message for the generated sections and files files
|
|
5
6
|
*
|
|
6
7
|
* @private within the repository
|
|
7
8
|
*/
|
|
8
9
|
export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has been generated so that any manual changes will be overwritten";
|
|
10
|
+
/**
|
|
11
|
+
* Name for the Promptbook
|
|
12
|
+
*
|
|
13
|
+
* TODO: [🗽] Unite branding and make single place for it
|
|
14
|
+
*
|
|
15
|
+
* @public exported from `@promptbook/core`
|
|
16
|
+
*/
|
|
17
|
+
export declare const NAME = "Promptbook";
|
|
9
18
|
/**
|
|
10
19
|
* Claim for the Promptbook
|
|
11
20
|
*
|
|
@@ -14,6 +23,22 @@ export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has be
|
|
|
14
23
|
* @public exported from `@promptbook/core`
|
|
15
24
|
*/
|
|
16
25
|
export declare const CLAIM = "It's time for a paradigm shift. The future of software in plain English, French or Latin";
|
|
26
|
+
/**
|
|
27
|
+
* Logo for the light theme
|
|
28
|
+
*
|
|
29
|
+
* TODO: [🗽] Unite branding and make single place for it
|
|
30
|
+
*
|
|
31
|
+
* @public exported from `@promptbook/core`
|
|
32
|
+
*/
|
|
33
|
+
export declare const LOGO_LIGHT_SRC: string_url_image;
|
|
34
|
+
/**
|
|
35
|
+
* Logo for the dark theme
|
|
36
|
+
*
|
|
37
|
+
* TODO: [🗽] Unite branding and make single place for it
|
|
38
|
+
*
|
|
39
|
+
* @public exported from `@promptbook/core`
|
|
40
|
+
*/
|
|
41
|
+
export declare const LOGO_DARK_SRC: string_url_image;
|
|
17
42
|
/**
|
|
18
43
|
* When the title is not provided, the default title is used
|
|
19
44
|
*
|
|
@@ -94,6 +119,13 @@ export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
|
|
|
94
119
|
* @public exported from `@promptbook/core`
|
|
95
120
|
*/
|
|
96
121
|
export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
|
|
122
|
+
/**
|
|
123
|
+
* Where to store your books
|
|
124
|
+
* This is kind of a "src" for your books
|
|
125
|
+
*
|
|
126
|
+
* @public exported from `@promptbook/core`
|
|
127
|
+
*/
|
|
128
|
+
export declare const DEFAULT_BOOKS_DIRNAME = "./books";
|
|
97
129
|
/**
|
|
98
130
|
* Where to store the cache of executions for promptbook CLI
|
|
99
131
|
*
|
|
@@ -101,7 +133,7 @@ export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
|
|
|
101
133
|
*
|
|
102
134
|
* @public exported from `@promptbook/core`
|
|
103
135
|
*/
|
|
104
|
-
export declare const DEFAULT_EXECUTIONS_CACHE_DIRNAME = "
|
|
136
|
+
export declare const DEFAULT_EXECUTIONS_CACHE_DIRNAME = "./.promptbook/executions-cache";
|
|
105
137
|
/**
|
|
106
138
|
* Where to store the scrape cache
|
|
107
139
|
*
|
|
@@ -109,7 +141,7 @@ export declare const DEFAULT_EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions
|
|
|
109
141
|
*
|
|
110
142
|
* @public exported from `@promptbook/core`
|
|
111
143
|
*/
|
|
112
|
-
export declare const DEFAULT_SCRAPE_CACHE_DIRNAME = "
|
|
144
|
+
export declare const DEFAULT_SCRAPE_CACHE_DIRNAME = "./.promptbook/scrape-cache";
|
|
113
145
|
/**
|
|
114
146
|
* The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
|
|
115
147
|
*
|
|
@@ -9,7 +9,7 @@ import type { PipelineString } from '../pipeline/PipelineString';
|
|
|
9
9
|
*/
|
|
10
10
|
export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
|
|
11
11
|
/**
|
|
12
|
-
* TODO: [🛋] Implement new features and commands into `pipelineJsonToString` + `
|
|
12
|
+
* TODO: [🛋] Implement new features and commands into `pipelineJsonToString` + `taskParameterJsonToString` , use `stringifyCommand`
|
|
13
13
|
* TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
|
|
14
14
|
* TODO: [🏛] Maybe make some markdown builder
|
|
15
15
|
* TODO: [🏛] Escape all
|
|
@@ -6,9 +6,9 @@ import type { string_href } from '../../types/typeAliases';
|
|
|
6
6
|
*/
|
|
7
7
|
export type renderPipelineMermaidOptions = {
|
|
8
8
|
/**
|
|
9
|
-
* Callback for creating from
|
|
9
|
+
* Callback for creating from task graph node
|
|
10
10
|
*/
|
|
11
|
-
|
|
11
|
+
linkTask?(task: TaskJson): {
|
|
12
12
|
href: string_href;
|
|
13
13
|
title: string;
|
|
14
14
|
} | null;
|
|
@@ -2,14 +2,14 @@ import type { ReadonlyDeep } from 'type-fest';
|
|
|
2
2
|
import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
|
|
3
3
|
import type { string_parameter_name } from '../../types/typeAliases';
|
|
4
4
|
/**
|
|
5
|
-
* Parses the
|
|
5
|
+
* Parses the task and returns the set of all used parameters
|
|
6
6
|
*
|
|
7
|
-
* @param
|
|
7
|
+
* @param task the task with used parameters
|
|
8
8
|
* @returns the set of parameter names
|
|
9
9
|
* @throws {ParseError} if the script is invalid
|
|
10
10
|
* @public exported from `@promptbook/utils`
|
|
11
11
|
*/
|
|
12
|
-
export declare function extractParameterNamesFromTask(
|
|
12
|
+
export declare function extractParameterNamesFromTask(task: ReadonlyDeep<Pick<TaskJson, 'title' | 'description' | 'taskType' | 'content' | 'preparedContent' | 'jokerParameterNames' | 'foreach'>>): Set<string_parameter_name>;
|
|
13
13
|
/**
|
|
14
14
|
* TODO: [🔣] If script require contentLanguage
|
|
15
15
|
*/
|
|
@@ -16,8 +16,8 @@ type RenameParameterOptions = {
|
|
|
16
16
|
readonly newParameterName: string_name;
|
|
17
17
|
};
|
|
18
18
|
/**
|
|
19
|
-
* Function `renameParameter` will find all usable parameters for given
|
|
20
|
-
* In other words, it will find all parameters that are not used in the
|
|
19
|
+
* Function `renameParameter` will find all usable parameters for given task
|
|
20
|
+
* In other words, it will find all parameters that are not used in the task itseld and all its dependencies
|
|
21
21
|
*
|
|
22
22
|
* @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
|
|
23
23
|
* @public exported from `@promptbook/utils`
|
|
@@ -13,7 +13,7 @@ export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
|
|
|
13
13
|
protected readonly options: CommonToolsOptions;
|
|
14
14
|
constructor(options?: CommonToolsOptions);
|
|
15
15
|
/**
|
|
16
|
-
* Trigger window.
|
|
16
|
+
* Trigger window.prompt dialog
|
|
17
17
|
*/
|
|
18
18
|
promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
|
|
19
19
|
}
|
|
@@ -2,7 +2,7 @@ import type { ScriptLanguage } from '../types/ScriptLanguage';
|
|
|
2
2
|
import type { Parameters } from '../types/typeAliases';
|
|
3
3
|
import type { string_script } from '../types/typeAliases';
|
|
4
4
|
/**
|
|
5
|
-
* Represents all the tools needed to execute SCRIPT
|
|
5
|
+
* Represents all the tools needed to execute `SCRIPT` tasks
|
|
6
6
|
*
|
|
7
7
|
* @see https://github.com/webgptorg/promptbook#script-execution-tools
|
|
8
8
|
*/
|
|
@@ -8,7 +8,7 @@ export declare const BoilerplateFormfactorDefinition: {
|
|
|
8
8
|
readonly description: "@@@";
|
|
9
9
|
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
|
|
10
10
|
readonly pipelineInterface: {
|
|
11
|
-
readonly
|
|
12
|
-
readonly
|
|
11
|
+
readonly inputParameters: readonly [];
|
|
12
|
+
readonly outputParameters: readonly [];
|
|
13
13
|
};
|
|
14
14
|
};
|
|
@@ -9,7 +9,37 @@ export declare const ChatbotFormfactorDefinition: {
|
|
|
9
9
|
readonly description: "@@@";
|
|
10
10
|
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/174";
|
|
11
11
|
readonly pipelineInterface: {
|
|
12
|
-
readonly
|
|
13
|
-
|
|
12
|
+
readonly inputParameters: readonly [{
|
|
13
|
+
readonly name: "previousTitle";
|
|
14
|
+
readonly description: "Previous title of the conversation";
|
|
15
|
+
readonly isInput: true;
|
|
16
|
+
readonly isOutput: false;
|
|
17
|
+
}, {
|
|
18
|
+
readonly name: "previousConversationSummary";
|
|
19
|
+
readonly description: "Previous conversation summary";
|
|
20
|
+
readonly isInput: true;
|
|
21
|
+
readonly isOutput: false;
|
|
22
|
+
}, {
|
|
23
|
+
readonly name: "userMessage";
|
|
24
|
+
readonly description: "User message";
|
|
25
|
+
readonly isInput: true;
|
|
26
|
+
readonly isOutput: false;
|
|
27
|
+
}];
|
|
28
|
+
readonly outputParameters: readonly [{
|
|
29
|
+
readonly name: "title";
|
|
30
|
+
readonly description: "Title of the conversation";
|
|
31
|
+
readonly isInput: false;
|
|
32
|
+
readonly isOutput: true;
|
|
33
|
+
}, {
|
|
34
|
+
readonly name: "conversationSummary";
|
|
35
|
+
readonly description: "Summary of the conversation";
|
|
36
|
+
readonly isInput: false;
|
|
37
|
+
readonly isOutput: true;
|
|
38
|
+
}, {
|
|
39
|
+
readonly name: "chatbotResponse";
|
|
40
|
+
readonly description: "Chatbot response";
|
|
41
|
+
readonly isInput: false;
|
|
42
|
+
readonly isOutput: true;
|
|
43
|
+
}];
|
|
14
44
|
};
|
|
15
45
|
};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generator is form of app that @@@
|
|
3
|
+
*
|
|
4
|
+
* @public exported from `@promptbook/core`
|
|
5
|
+
*/
|
|
6
|
+
export declare const GeneratorFormfactorDefinition: {
|
|
7
|
+
readonly name: "GENERATOR";
|
|
8
|
+
readonly description: "@@@";
|
|
9
|
+
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184";
|
|
10
|
+
readonly pipelineInterface: {
|
|
11
|
+
readonly inputParameters: readonly [];
|
|
12
|
+
readonly outputParameters: readonly [];
|
|
13
|
+
};
|
|
14
|
+
};
|
|
@@ -8,7 +8,7 @@ export declare const GenericFormfactorDefinition: {
|
|
|
8
8
|
readonly description: "@@@";
|
|
9
9
|
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/173";
|
|
10
10
|
readonly pipelineInterface: {
|
|
11
|
-
readonly
|
|
12
|
-
readonly
|
|
11
|
+
readonly inputParameters: readonly [];
|
|
12
|
+
readonly outputParameters: readonly [];
|
|
13
13
|
};
|
|
14
14
|
};
|
|
@@ -8,8 +8,8 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
|
|
|
8
8
|
readonly description: "@@@";
|
|
9
9
|
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/173";
|
|
10
10
|
readonly pipelineInterface: {
|
|
11
|
-
readonly
|
|
12
|
-
readonly
|
|
11
|
+
readonly inputParameters: readonly [];
|
|
12
|
+
readonly outputParameters: readonly [];
|
|
13
13
|
};
|
|
14
14
|
}, {
|
|
15
15
|
readonly name: "CHATBOT";
|
|
@@ -17,32 +17,94 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
|
|
|
17
17
|
readonly description: "@@@";
|
|
18
18
|
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/174";
|
|
19
19
|
readonly pipelineInterface: {
|
|
20
|
-
readonly
|
|
21
|
-
|
|
20
|
+
readonly inputParameters: readonly [{
|
|
21
|
+
readonly name: "previousTitle";
|
|
22
|
+
readonly description: "Previous title of the conversation"; /**
|
|
23
|
+
* All available formfactor definitions
|
|
24
|
+
*
|
|
25
|
+
* @public exported from `@promptbook/core`
|
|
26
|
+
*/
|
|
27
|
+
readonly isInput: true;
|
|
28
|
+
readonly isOutput: false;
|
|
29
|
+
}, {
|
|
30
|
+
readonly name: "previousConversationSummary";
|
|
31
|
+
readonly description: "Previous conversation summary";
|
|
32
|
+
readonly isInput: true;
|
|
33
|
+
readonly isOutput: false;
|
|
34
|
+
}, {
|
|
35
|
+
readonly name: "userMessage";
|
|
36
|
+
readonly description: "User message";
|
|
37
|
+
readonly isInput: true;
|
|
38
|
+
readonly isOutput: false;
|
|
39
|
+
}];
|
|
40
|
+
readonly outputParameters: readonly [{
|
|
41
|
+
readonly name: "title";
|
|
42
|
+
readonly description: "Title of the conversation";
|
|
43
|
+
readonly isInput: false;
|
|
44
|
+
readonly isOutput: true;
|
|
45
|
+
}, {
|
|
46
|
+
readonly name: "conversationSummary";
|
|
47
|
+
readonly description: "Summary of the conversation";
|
|
48
|
+
readonly isInput: false;
|
|
49
|
+
readonly isOutput: true;
|
|
50
|
+
}, {
|
|
51
|
+
readonly name: "chatbotResponse";
|
|
52
|
+
readonly description: "Chatbot response";
|
|
53
|
+
readonly isInput: false;
|
|
54
|
+
readonly isOutput: true;
|
|
55
|
+
}];
|
|
22
56
|
};
|
|
23
57
|
}, {
|
|
24
58
|
readonly name: "TRANSLATOR";
|
|
25
59
|
readonly description: "@@@";
|
|
26
60
|
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/175";
|
|
27
61
|
readonly pipelineInterface: {
|
|
28
|
-
readonly
|
|
29
|
-
|
|
62
|
+
readonly inputParameters: readonly [{
|
|
63
|
+
readonly name: "inputMessage";
|
|
64
|
+
readonly description: "Input message to be translated";
|
|
65
|
+
readonly isInput: true;
|
|
66
|
+
readonly isOutput: false;
|
|
67
|
+
}];
|
|
68
|
+
readonly outputParameters: readonly [{
|
|
69
|
+
readonly name: "outputMessage";
|
|
70
|
+
readonly description: "Translated output message";
|
|
71
|
+
readonly isInput: false;
|
|
72
|
+
readonly isOutput: true;
|
|
73
|
+
}];
|
|
30
74
|
};
|
|
31
75
|
}, {
|
|
32
76
|
readonly name: "SHEETS";
|
|
33
77
|
readonly description: "@@@";
|
|
34
78
|
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/176";
|
|
35
79
|
readonly pipelineInterface: {
|
|
36
|
-
readonly
|
|
37
|
-
|
|
80
|
+
readonly inputParameters: readonly [{
|
|
81
|
+
readonly name: "inputSheet";
|
|
82
|
+
readonly description: "Input sheet to be processed as csv";
|
|
83
|
+
readonly isInput: true;
|
|
84
|
+
readonly isOutput: false;
|
|
85
|
+
}];
|
|
86
|
+
readonly outputParameters: readonly [{
|
|
87
|
+
readonly name: "outputSheet";
|
|
88
|
+
readonly description: "Output sheet as csv";
|
|
89
|
+
readonly isInput: false;
|
|
90
|
+
readonly isOutput: true;
|
|
91
|
+
}];
|
|
38
92
|
};
|
|
39
93
|
}, {
|
|
40
94
|
readonly name: "EXPERIMENTAL_MATCHER";
|
|
41
95
|
readonly description: "@@@";
|
|
42
96
|
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/177";
|
|
43
97
|
readonly pipelineInterface: {
|
|
44
|
-
readonly
|
|
45
|
-
readonly
|
|
98
|
+
readonly inputParameters: readonly [];
|
|
99
|
+
readonly outputParameters: readonly [];
|
|
100
|
+
};
|
|
101
|
+
}, {
|
|
102
|
+
readonly name: "GENERATOR";
|
|
103
|
+
readonly description: "@@@";
|
|
104
|
+
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184";
|
|
105
|
+
readonly pipelineInterface: {
|
|
106
|
+
readonly inputParameters: readonly [];
|
|
107
|
+
readonly outputParameters: readonly [];
|
|
46
108
|
};
|
|
47
109
|
}];
|
|
48
110
|
/**
|
|
@@ -8,7 +8,7 @@ export declare const MatcherFormfactorDefinition: {
|
|
|
8
8
|
readonly description: "@@@";
|
|
9
9
|
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/177";
|
|
10
10
|
readonly pipelineInterface: {
|
|
11
|
-
readonly
|
|
12
|
-
readonly
|
|
11
|
+
readonly inputParameters: readonly [];
|
|
12
|
+
readonly outputParameters: readonly [];
|
|
13
13
|
};
|
|
14
14
|
};
|
|
@@ -8,7 +8,17 @@ export declare const SheetsFormfactorDefinition: {
|
|
|
8
8
|
readonly description: "@@@";
|
|
9
9
|
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/176";
|
|
10
10
|
readonly pipelineInterface: {
|
|
11
|
-
readonly
|
|
12
|
-
|
|
11
|
+
readonly inputParameters: readonly [{
|
|
12
|
+
readonly name: "inputSheet";
|
|
13
|
+
readonly description: "Input sheet to be processed as csv";
|
|
14
|
+
readonly isInput: true;
|
|
15
|
+
readonly isOutput: false;
|
|
16
|
+
}];
|
|
17
|
+
readonly outputParameters: readonly [{
|
|
18
|
+
readonly name: "outputSheet";
|
|
19
|
+
readonly description: "Output sheet as csv";
|
|
20
|
+
readonly isInput: false;
|
|
21
|
+
readonly isOutput: true;
|
|
22
|
+
}];
|
|
13
23
|
};
|
|
14
24
|
};
|
|
@@ -8,7 +8,17 @@ export declare const TranslatorFormfactorDefinition: {
|
|
|
8
8
|
readonly description: "@@@";
|
|
9
9
|
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/175";
|
|
10
10
|
readonly pipelineInterface: {
|
|
11
|
-
readonly
|
|
12
|
-
|
|
11
|
+
readonly inputParameters: readonly [{
|
|
12
|
+
readonly name: "inputMessage";
|
|
13
|
+
readonly description: "Input message to be translated";
|
|
14
|
+
readonly isInput: true;
|
|
15
|
+
readonly isOutput: false;
|
|
16
|
+
}];
|
|
17
|
+
readonly outputParameters: readonly [{
|
|
18
|
+
readonly name: "outputMessage";
|
|
19
|
+
readonly description: "Translated output message";
|
|
20
|
+
readonly isInput: false;
|
|
21
|
+
readonly isOutput: true;
|
|
22
|
+
}];
|
|
13
23
|
};
|
|
14
24
|
};
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { InputParameterJson } from '../PipelineJson/ParameterJson';
|
|
2
|
+
import type { OutputParameterJson } from '../PipelineJson/ParameterJson';
|
|
2
3
|
/**
|
|
3
4
|
* @@@
|
|
4
5
|
*
|
|
@@ -11,15 +12,15 @@ export type PipelineInterface = {
|
|
|
11
12
|
*
|
|
12
13
|
* Note: Sorted alphabetically
|
|
13
14
|
*/
|
|
14
|
-
readonly
|
|
15
|
+
readonly inputParameters: ReadonlyArray<InputParameterJson>;
|
|
15
16
|
/**
|
|
16
17
|
* @@@
|
|
17
18
|
*
|
|
18
19
|
* Note: Sorted alphabetically
|
|
19
20
|
*/
|
|
20
|
-
readonly
|
|
21
|
+
readonly outputParameters: ReadonlyArray<OutputParameterJson>;
|
|
21
22
|
};
|
|
22
23
|
/**
|
|
23
|
-
* TODO:
|
|
24
|
+
* TODO: [🧠][🤓] How to pass optional parameters - for example summary in FORMFACTOR Translator
|
|
24
25
|
* TODO: [🧠] Better name than `PipelineInterface` to avoid confusion with typescript `interface`
|
|
25
26
|
*/
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
* @public exported from `@promptbook/core`
|
|
7
7
|
*/
|
|
8
8
|
export declare const GENERIC_PIPELINE_INTERFACE: {
|
|
9
|
-
readonly
|
|
10
|
-
readonly
|
|
9
|
+
readonly inputParameters: readonly [];
|
|
10
|
+
readonly outputParameters: readonly [];
|
|
11
11
|
};
|
|
12
12
|
/**
|
|
13
13
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|