@promptbook/markdown-utils 0.75.0-1 → 0.75.0-2
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 +1 -0
- package/esm/index.es.js +233 -218
- package/esm/index.es.js.map +1 -1
- package/esm/typings/promptbook-collection/index.d.ts +6 -6
- package/esm/typings/src/_packages/core.index.d.ts +22 -20
- package/esm/typings/src/_packages/types.index.d.ts +58 -50
- package/esm/typings/src/_packages/utils.index.d.ts +2 -2
- package/esm/typings/src/cli/cli-commands/about.d.ts +1 -0
- package/esm/typings/src/cli/cli-commands/hello.d.ts +1 -0
- package/esm/typings/src/cli/cli-commands/make.d.ts +1 -0
- package/esm/typings/src/cli/cli-commands/prettify.d.ts +1 -0
- package/esm/typings/src/cli/cli-commands/run.d.ts +1 -0
- package/esm/typings/src/cli/cli-commands/test-command.d.ts +1 -0
- package/esm/typings/src/cli/main.d.ts +1 -0
- package/esm/typings/src/collection/PipelineCollection.d.ts +1 -1
- package/esm/typings/src/collection/SimplePipelineCollection.d.ts +1 -1
- package/esm/typings/src/collection/collectionToJson.d.ts +1 -1
- package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +1 -1
- package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +1 -1
- package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts +2 -2
- package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +2 -2
- package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +2 -2
- package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +2 -2
- package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +2 -2
- package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +2 -2
- package/esm/typings/src/commands/SECTION/SectionCommand.d.ts +11 -0
- package/esm/typings/src/commands/SECTION/SectionType.d.ts +13 -0
- package/esm/typings/src/commands/{TEMPLATE/templateCommandParser.d.ts → SECTION/sectionCommandParser.d.ts} +6 -6
- package/esm/typings/src/commands/_common/types/Command.d.ts +1 -1
- package/esm/typings/src/commands/_common/types/CommandParser.d.ts +17 -17
- package/esm/typings/src/commands/_common/types/CommandUsagePlaces.d.ts +1 -1
- package/esm/typings/src/commands/index.d.ts +4 -1
- package/esm/typings/src/config.d.ts +2 -1
- package/esm/typings/src/conversion/pipelineJsonToString.d.ts +2 -2
- package/esm/typings/src/conversion/pipelineStringToJson.d.ts +2 -2
- package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +3 -3
- package/esm/typings/src/conversion/prettify/prettifyPipelineString.d.ts +1 -1
- package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +3 -3
- package/esm/typings/src/conversion/utils/{extractParameterNamesFromTemplate.d.ts → extractParameterNamesFromTask.d.ts} +2 -2
- package/esm/typings/src/conversion/utils/renameParameter.d.ts +1 -1
- package/esm/typings/src/conversion/validation/_importPipeline.d.ts +3 -2
- package/esm/typings/src/conversion/validation/validatePipeline.d.ts +1 -1
- package/esm/typings/src/errors/index.d.ts +3 -0
- package/esm/typings/src/execution/PipelineExecutorResult.d.ts +2 -2
- package/esm/typings/src/execution/PromptResultUsage.d.ts +1 -1
- package/esm/typings/src/execution/createPipelineExecutor/{$OngoingTemplateResult.d.ts → $OngoingTaskResult.d.ts} +1 -1
- package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +1 -1
- package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +1 -1
- package/esm/typings/src/execution/createPipelineExecutor/{20-executeTemplate.d.ts → 20-executeTask.d.ts} +7 -7
- package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +5 -5
- package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +1 -1
- package/esm/typings/src/execution/createPipelineExecutor/{getContextForTemplate.d.ts → getContextForTask.d.ts} +2 -2
- package/esm/typings/src/execution/createPipelineExecutor/{getExamplesForTemplate.d.ts → getExamplesForTask.d.ts} +2 -2
- package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +27 -0
- package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts +30 -0
- package/esm/typings/src/{types → execution}/execution-report/ExecutionPromptReportJson.d.ts +2 -2
- package/esm/typings/src/{types → execution}/execution-report/ExecutionReportJson.d.ts +4 -4
- package/esm/typings/src/{types → execution}/execution-report/ExecutionReportStringOptions.d.ts +1 -1
- package/esm/typings/src/execution/utils/checkExpectations.d.ts +1 -1
- package/esm/typings/src/execution/utils/usage-constants.d.ts +3 -0
- package/esm/typings/src/formats/index.d.ts +3 -0
- package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +4 -1
- package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts +3 -0
- package/esm/typings/src/formfactors/{chat/ChatFormfactorDefinition.d.ts → chatbot/ChatbotFormfactorDefinition.d.ts} +2 -2
- package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts +1 -1
- package/esm/typings/src/formfactors/index.d.ts +15 -4
- package/esm/typings/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts +14 -0
- package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts +1 -1
- package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts +1 -1
- package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -0
- package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +3 -0
- package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +1 -0
- package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +3 -0
- package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +1 -0
- package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +1 -1
- package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -0
- package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +3 -0
- package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +1 -0
- package/esm/typings/src/personas/preparePersona.d.ts +1 -1
- package/esm/typings/src/pipeline/{pipeline-interface → PipelineInterface}/PipelineInterface.d.ts +3 -0
- package/esm/typings/src/pipeline/{pipeline-interface → PipelineInterface}/constants.d.ts +5 -0
- package/esm/typings/src/pipeline/{pipeline-interface → PipelineInterface}/getPipelineInterface.d.ts +3 -1
- package/esm/typings/src/pipeline/{pipeline-interface → PipelineInterface}/isPipelineImplementingInterface.d.ts +5 -1
- package/esm/typings/src/pipeline/{pipeline-interface → PipelineInterface}/isPipelineInterfacesEqual.d.ts +2 -0
- package/esm/typings/src/pipeline/PipelineJson/DialogTaskJson.d.ts +13 -0
- package/esm/typings/src/{types → pipeline}/PipelineJson/Expectations.d.ts +2 -2
- package/esm/typings/src/{types → pipeline}/PipelineJson/KnowledgePieceJson.d.ts +7 -6
- package/esm/typings/src/{types → pipeline}/PipelineJson/KnowledgeSourceJson.d.ts +3 -3
- package/esm/typings/src/pipeline/PipelineJson/ParameterJson.d.ts +96 -0
- package/esm/typings/src/{types → pipeline}/PipelineJson/PersonaJson.d.ts +4 -4
- package/esm/typings/src/{types → pipeline}/PipelineJson/PipelineJson.d.ts +10 -10
- package/esm/typings/src/{types → pipeline}/PipelineJson/PreparationJson.d.ts +1 -1
- package/esm/typings/src/{types/PipelineJson/PromptTemplateJson.d.ts → pipeline/PipelineJson/PromptTaskJson.d.ts} +8 -8
- package/esm/typings/src/pipeline/PipelineJson/ScriptTaskJson.d.ts +20 -0
- package/esm/typings/src/pipeline/PipelineJson/SimpleTaskJson.d.ts +13 -0
- package/esm/typings/src/pipeline/PipelineJson/TaskJson.d.ts +11 -0
- package/esm/typings/src/{types/PipelineJson/TemplateJsonCommon.d.ts → pipeline/PipelineJson/TaskJsonCommon.d.ts} +13 -13
- package/esm/typings/src/{types → pipeline}/PipelineString.d.ts +1 -1
- package/esm/typings/src/prepare/isPipelinePrepared.d.ts +2 -2
- package/esm/typings/src/prepare/preparePipeline.d.ts +1 -1
- package/esm/typings/src/prepare/{prepareTemplates.d.ts → prepareTasks.d.ts} +7 -7
- package/esm/typings/src/prepare/unpreparePipeline.d.ts +1 -1
- package/esm/typings/src/scrapers/_common/Scraper.d.ts +1 -1
- package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts +2 -2
- package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +1 -1
- package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +1 -1
- package/esm/typings/src/scrapers/document/register-constructor.d.ts +1 -0
- package/esm/typings/src/scrapers/document/register-metadata.d.ts +3 -0
- package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +1 -1
- package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +1 -0
- package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +3 -0
- package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +1 -1
- package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +1 -0
- package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +3 -0
- package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +1 -1
- package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +1 -0
- package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +3 -0
- package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +1 -1
- package/esm/typings/src/scrapers/website/register-constructor.d.ts +1 -0
- package/esm/typings/src/scrapers/website/register-metadata.d.ts +3 -0
- package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts +1 -0
- package/esm/typings/src/types/Prompt.d.ts +1 -1
- package/esm/typings/src/types/TaskProgress.d.ts +2 -2
- package/esm/typings/src/types/typeAliasEmoji.d.ts +3 -0
- package/esm/typings/src/types/typeAliases.d.ts +1 -0
- package/esm/typings/src/utils/emojis.d.ts +1 -0
- package/esm/typings/src/utils/expectation-counters/constants.d.ts +1 -0
- package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts +1 -1
- package/esm/typings/src/utils/expectation-counters/countLines.d.ts +1 -1
- package/esm/typings/src/utils/expectation-counters/countPages.d.ts +1 -1
- package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts +1 -1
- package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +1 -1
- package/esm/typings/src/utils/expectation-counters/countWords.d.ts +1 -1
- package/esm/typings/src/utils/expectation-counters/index.d.ts +3 -2
- package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts +3 -0
- package/esm/typings/src/utils/parameters/extractParameterNames.d.ts +2 -2
- package/esm/typings/src/utils/serialization/clonePipeline.d.ts +1 -1
- package/esm/typings/src/version.d.ts +2 -1
- package/package.json +4 -3
- package/umd/index.umd.js +233 -218
- package/umd/index.umd.js.map +1 -1
- package/esm/typings/src/commands/TEMPLATE/TemplateCommand.d.ts +0 -11
- package/esm/typings/src/commands/TEMPLATE/TemplateTypes.d.ts +0 -15
- package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTemplate.d.ts +0 -27
- package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTemplate.d.ts +0 -30
- package/esm/typings/src/types/PipelineJson/DialogTemplateJson.d.ts +0 -13
- package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts +0 -39
- package/esm/typings/src/types/PipelineJson/ScriptTemplateJson.d.ts +0 -20
- package/esm/typings/src/types/PipelineJson/SimpleTemplateJson.d.ts +0 -13
- package/esm/typings/src/types/PipelineJson/TemplateJson.d.ts +0 -11
- /package/esm/typings/src/commands/{TEMPLATE/templateCommand.test.d.ts → SECTION/sectionCommand.test.d.ts} +0 -0
- /package/esm/typings/src/conversion/utils/{extractParameterNamesFromTemplate.test.d.ts → extractParameterNamesFromTask.test.d.ts} +0 -0
- /package/esm/typings/src/{types → execution}/execution-report/ExecutionReportString.d.ts +0 -0
- /package/esm/typings/src/{types → execution}/execution-report/countWorkingDuration.d.ts +0 -0
- /package/esm/typings/src/{types → execution}/execution-report/countWorkingDuration.test.d.ts +0 -0
- /package/esm/typings/src/{types → execution}/execution-report/executionReportJsonToString.d.ts +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { WritableDeep } from 'type-fest';
|
|
2
|
-
import type { PipelineJson } from '../../../
|
|
3
|
-
import type {
|
|
2
|
+
import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
|
|
3
|
+
import type { TaskJson } from '../../../pipeline/PipelineJson/TaskJson';
|
|
4
4
|
import type { string_markdown_text } from '../../../types/typeAliases';
|
|
5
5
|
import type { string_name } from '../../../types/typeAliases';
|
|
6
6
|
import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
|
|
@@ -18,7 +18,7 @@ export type CommandBase = {
|
|
|
18
18
|
/**
|
|
19
19
|
* @@@
|
|
20
20
|
*/
|
|
21
|
-
export type CommandParser<TCommand extends CommandBase> = PipelineHeadCommandParser<TCommand> |
|
|
21
|
+
export type CommandParser<TCommand extends CommandBase> = PipelineHeadCommandParser<TCommand> | PipelineTaskCommandParser<TCommand> | PipelineBothCommandParser<TCommand>;
|
|
22
22
|
/**
|
|
23
23
|
* @@@
|
|
24
24
|
*
|
|
@@ -36,7 +36,7 @@ export type CommonCommandParser<TCommand extends CommandBase> = {
|
|
|
36
36
|
/**
|
|
37
37
|
* @@@
|
|
38
38
|
*/
|
|
39
|
-
readonly
|
|
39
|
+
readonly isUsedInPipelineTask: boolean;
|
|
40
40
|
/**
|
|
41
41
|
* @@@
|
|
42
42
|
*/
|
|
@@ -71,7 +71,7 @@ export type CommonCommandParser<TCommand extends CommandBase> = {
|
|
|
71
71
|
/**
|
|
72
72
|
* @@@
|
|
73
73
|
*/
|
|
74
|
-
export type PipelineBothCommandParser<TCommand extends CommandBase> = ___and___ & Omit<PipelineHeadCommandParser<TCommand>, '
|
|
74
|
+
export type PipelineBothCommandParser<TCommand extends CommandBase> = ___and___ & Omit<PipelineHeadCommandParser<TCommand>, 'isUsedInPipelineTask'> & Omit<PipelineTaskCommandParser<TCommand>, 'isUsedInPipelineHead'>;
|
|
75
75
|
/**
|
|
76
76
|
* @@@
|
|
77
77
|
*/
|
|
@@ -83,7 +83,7 @@ export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonComm
|
|
|
83
83
|
/**
|
|
84
84
|
* @@@
|
|
85
85
|
*/
|
|
86
|
-
readonly
|
|
86
|
+
readonly isUsedInPipelineTask: false;
|
|
87
87
|
/**
|
|
88
88
|
* Apply the command to the `pipelineJson`
|
|
89
89
|
*
|
|
@@ -102,7 +102,7 @@ export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonComm
|
|
|
102
102
|
*
|
|
103
103
|
* TODO: !!!!!! Rename to PipelineTaskCommandParser, applyToTaskJson, TaskJson, isUsedInPipelineTask,...
|
|
104
104
|
*/
|
|
105
|
-
export type
|
|
105
|
+
export type PipelineTaskCommandParser<TCommand extends CommandBase> = CommonCommandParser<TCommand> & {
|
|
106
106
|
/**
|
|
107
107
|
* @@@
|
|
108
108
|
*/
|
|
@@ -110,19 +110,19 @@ export type PipelineTemplateCommandParser<TCommand extends CommandBase> = Common
|
|
|
110
110
|
/**
|
|
111
111
|
* @@@
|
|
112
112
|
*/
|
|
113
|
-
readonly
|
|
113
|
+
readonly isUsedInPipelineTask: true;
|
|
114
114
|
/**
|
|
115
115
|
* Apply the command to the `pipelineJson`
|
|
116
116
|
*
|
|
117
|
-
* Note: `$` is used to indicate that this function mutates given `
|
|
117
|
+
* Note: `$` is used to indicate that this function mutates given `taskJson` and/or `pipelineJson`
|
|
118
118
|
*/
|
|
119
|
-
$
|
|
119
|
+
$applyToTaskJson(command: TCommand, $taskJson: $TaskJson, $pipelineJson: $PipelineJson): void;
|
|
120
120
|
/**
|
|
121
|
-
* Reads the command from the `
|
|
121
|
+
* Reads the command from the `TaskJson`
|
|
122
122
|
*
|
|
123
123
|
* Note: This is used in `pipelineJsonToString` utility
|
|
124
124
|
*/
|
|
125
|
-
|
|
125
|
+
takeFromTaskJson($taskJson: $TaskJson): ReadonlyArray<TCommand>;
|
|
126
126
|
};
|
|
127
127
|
/**
|
|
128
128
|
* @@@
|
|
@@ -131,10 +131,10 @@ export type PipelineTemplateCommandParser<TCommand extends CommandBase> = Common
|
|
|
131
131
|
*
|
|
132
132
|
* @private internal helper for command parsers
|
|
133
133
|
*/
|
|
134
|
-
export type $
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
} & Partial<WritableDeep<
|
|
134
|
+
export type $TaskJson = {
|
|
135
|
+
isSectionTypeSet: boolean;
|
|
136
|
+
isTask: boolean;
|
|
137
|
+
} & Partial<WritableDeep<TaskJson>>;
|
|
138
138
|
/**
|
|
139
139
|
* @@@
|
|
140
140
|
*
|
|
@@ -151,7 +151,7 @@ export type CommandParserInput = {
|
|
|
151
151
|
* @@@
|
|
152
152
|
*
|
|
153
153
|
* @example 'PIPELINE_HEAD'
|
|
154
|
-
* @example '
|
|
154
|
+
* @example 'PIPELINE_TASK'
|
|
155
155
|
*/
|
|
156
156
|
readonly usagePlace: CommandUsagePlace;
|
|
157
157
|
/**
|
|
@@ -8,4 +8,4 @@ export type CommandUsagePlace = TupleToUnion<typeof CommandUsagePlaces>;
|
|
|
8
8
|
*
|
|
9
9
|
* @private internal base for `CommandUsagePlace`
|
|
10
10
|
*/
|
|
11
|
-
export declare const CommandUsagePlaces: readonly ["PIPELINE_HEAD", "
|
|
11
|
+
export declare const CommandUsagePlaces: readonly ["PIPELINE_HEAD", "PIPELINE_TASK"];
|
|
@@ -3,4 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* @private internal index of `parseCommand`
|
|
5
5
|
*/
|
|
6
|
-
export declare const COMMANDS: readonly [import("./_common/types/CommandParser").
|
|
6
|
+
export declare const COMMANDS: readonly [import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./SECTION/SectionCommand").SectionCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./EXPECT/ExpectCommand").ExpectCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./FORMAT/FormatCommand").FormatCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./JOKER/JokerCommand").JokerCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./MODEL/ModelCommand").ModelCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PARAMETER/ParameterCommand").ParameterCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./POSTPROCESS/PostprocessCommand").PostprocessCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./BOOK_VERSION/BookVersionCommand").BookVersionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./FORMFACTOR/FormfactorCommand").FormfactorCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./URL/UrlCommand").UrlCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./KNOWLEDGE/KnowledgeCommand").KnowledgeCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_ACTION/ActionCommand").ActionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_INSTRUMENT/InstrumentCommand").InstrumentCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PERSONA/PersonaCommand").PersonaCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./FOREACH/ForeachCommand").ForeachCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./_BOILERPLATE/BoilerplateCommand").BoilerplateCommand>];
|
|
7
|
+
/**
|
|
8
|
+
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
9
|
+
*/
|
|
@@ -13,7 +13,7 @@ export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has be
|
|
|
13
13
|
*
|
|
14
14
|
* @public exported from `@promptbook/core`
|
|
15
15
|
*/
|
|
16
|
-
export declare const CLAIM = "
|
|
16
|
+
export declare const CLAIM = "It's time for a paradigm shift. The future of software in plain English, French or Latin";
|
|
17
17
|
/**
|
|
18
18
|
* When the title is not provided, the default title is used
|
|
19
19
|
*
|
|
@@ -193,5 +193,6 @@ export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
|
|
|
193
193
|
export declare const IS_COST_PREVENTED: boolean;
|
|
194
194
|
/**
|
|
195
195
|
* TODO: Extract `constants.ts` from `config.ts`
|
|
196
|
+
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
196
197
|
* TODO: [🧠][🧜♂️] Maybe join remoteUrl and path into single value
|
|
197
198
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { PipelineJson } from '../
|
|
2
|
-
import type { PipelineString } from '../
|
|
1
|
+
import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
|
|
2
|
+
import type { PipelineString } from '../pipeline/PipelineString';
|
|
3
3
|
/**
|
|
4
4
|
* Converts promptbook in JSON format to string format
|
|
5
5
|
*
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { ExecutionTools } from '../execution/ExecutionTools';
|
|
2
|
+
import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
|
|
3
|
+
import type { PipelineString } from '../pipeline/PipelineString';
|
|
2
4
|
import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
|
|
3
|
-
import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
|
|
4
|
-
import type { PipelineString } from '../types/PipelineString';
|
|
5
5
|
/**
|
|
6
6
|
* Compile pipeline from string (markdown) format to JSON format
|
|
7
7
|
*
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { PipelineJson } from '../
|
|
2
|
-
import type { PipelineString } from '../
|
|
1
|
+
import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
|
|
2
|
+
import type { PipelineString } from '../pipeline/PipelineString';
|
|
3
3
|
/**
|
|
4
4
|
* Compile pipeline from string (markdown) format to JSON format synchronously
|
|
5
5
|
*
|
|
@@ -23,7 +23,7 @@ export declare function pipelineStringToJsonSync(pipelineString: PipelineString)
|
|
|
23
23
|
* TODO: Use spaceTrim more effectively
|
|
24
24
|
* TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
|
|
25
25
|
* TODO: [🥞] Not optimal parsing because `splitMarkdownIntoSections` is executed twice with same string, once through `flattenMarkdown` and second directly here
|
|
26
|
-
* TODO: [♈] Probbably move expectations from
|
|
26
|
+
* TODO: [♈] Probbably move expectations from tasks to parameters
|
|
27
27
|
* TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
|
|
28
28
|
* TODO: [🍙] Make some standard order of json properties
|
|
29
29
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { PipelineJson } from '../../
|
|
2
|
-
import type {
|
|
1
|
+
import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
|
|
2
|
+
import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
|
|
3
3
|
import type { string_href } from '../../types/typeAliases';
|
|
4
4
|
/**
|
|
5
5
|
* Addtional options for rendering Mermaid graph
|
|
@@ -8,7 +8,7 @@ export type renderPipelineMermaidOptions = {
|
|
|
8
8
|
/**
|
|
9
9
|
* Callback for creating from template graph node
|
|
10
10
|
*/
|
|
11
|
-
linkTemplate?(template:
|
|
11
|
+
linkTemplate?(template: TaskJson): {
|
|
12
12
|
href: string_href;
|
|
13
13
|
title: string;
|
|
14
14
|
} | null;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { ReadonlyDeep } from 'type-fest';
|
|
2
|
-
import type {
|
|
2
|
+
import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
|
|
3
3
|
import type { string_parameter_name } from '../../types/typeAliases';
|
|
4
4
|
/**
|
|
5
5
|
* Parses the template and returns the set of all used parameters
|
|
@@ -9,7 +9,7 @@ import type { string_parameter_name } from '../../types/typeAliases';
|
|
|
9
9
|
* @throws {ParseError} if the script is invalid
|
|
10
10
|
* @public exported from `@promptbook/utils`
|
|
11
11
|
*/
|
|
12
|
-
export declare function
|
|
12
|
+
export declare function extractParameterNamesFromTask(template: 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
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { PipelineJson } from '../../
|
|
2
|
-
import type { PipelineString } from '../../
|
|
1
|
+
import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
|
|
2
|
+
import type { PipelineString } from '../../pipeline/PipelineString';
|
|
3
3
|
import type { string_json } from '../../types/typeAliases';
|
|
4
4
|
/**
|
|
5
5
|
* Import the pipeline.book.md or pipeline.book.json file
|
|
@@ -25,5 +25,6 @@ export declare function importPipelineJson(path: `${string}.book.json`): Pipelin
|
|
|
25
25
|
*/
|
|
26
26
|
export declare function importPipelineJsonAsString(path: `${string}.book.json`): string_json<PipelineJson>;
|
|
27
27
|
/**
|
|
28
|
+
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
28
29
|
* Note: [⚫] Code in this file should never be published in any package
|
|
29
30
|
*/
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ReadonlyDeep } from 'type-fest';
|
|
2
2
|
import type { ErrorJson } from '../errors/utils/ErrorJson';
|
|
3
|
-
import type {
|
|
4
|
-
import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
|
|
3
|
+
import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
|
|
5
4
|
import type { Parameters } from '../types/typeAliases';
|
|
5
|
+
import type { ExecutionReportJson } from './execution-report/ExecutionReportJson';
|
|
6
6
|
import type { PromptResultUsage } from './PromptResultUsage';
|
|
7
7
|
/**
|
|
8
8
|
* @@@
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { KebabCase } from 'type-fest';
|
|
2
|
-
import type { ExpectationUnit } from '../
|
|
2
|
+
import type { ExpectationUnit } from '../pipeline/PipelineJson/Expectations';
|
|
3
3
|
import type { UncertainNumber } from './UncertainNumber';
|
|
4
4
|
/**
|
|
5
5
|
* Usage statistics for one or many prompt results
|
package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { CsvSettings } from '../../formats/csv/CsvSettings';
|
|
2
|
+
import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
|
|
2
3
|
import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
|
|
3
|
-
import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
|
|
4
4
|
import type { ExecutionTools } from '../ExecutionTools';
|
|
5
5
|
/**
|
|
6
6
|
* Options for `createPipelineExecutor`
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Promisable, ReadonlyDeep } from 'type-fest';
|
|
2
|
-
import type { PipelineJson } from '../../
|
|
2
|
+
import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
|
|
3
3
|
import type { TaskProgress } from '../../types/TaskProgress';
|
|
4
4
|
import type { Parameters } from '../../types/typeAliases';
|
|
5
5
|
import type { PipelineExecutorResult } from '../PipelineExecutorResult';
|
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
import type { Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
|
|
2
|
-
import type {
|
|
3
|
-
import type {
|
|
4
|
-
import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
|
|
2
|
+
import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
|
|
3
|
+
import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
|
|
5
4
|
import type { TaskProgress } from '../../types/TaskProgress';
|
|
6
5
|
import type { Parameters } from '../../types/typeAliases';
|
|
6
|
+
import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
|
|
7
7
|
import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
|
|
8
8
|
/**
|
|
9
9
|
* @@@
|
|
10
10
|
*
|
|
11
|
-
* @private internal type of `
|
|
11
|
+
* @private internal type of `executeTask`
|
|
12
12
|
*/
|
|
13
|
-
type
|
|
13
|
+
type executeSingleTaskOptions = CreatePipelineExecutorOptions & {
|
|
14
14
|
/**
|
|
15
15
|
* @@@
|
|
16
16
|
*/
|
|
17
|
-
readonly
|
|
17
|
+
readonly currentTask: ReadonlyDeep<TaskJson>;
|
|
18
18
|
/**
|
|
19
19
|
* @@@
|
|
20
20
|
*/
|
|
@@ -41,7 +41,7 @@ type executeSingleTemplateOptions = CreatePipelineExecutorOptions & {
|
|
|
41
41
|
*
|
|
42
42
|
* @private internal utility of `createPipelineExecutor`
|
|
43
43
|
*/
|
|
44
|
-
export declare function
|
|
44
|
+
export declare function executeTask(options: executeSingleTaskOptions): Promise<Readonly<Parameters>>;
|
|
45
45
|
export {};
|
|
46
46
|
/**
|
|
47
47
|
* TODO: [🤹♂️]
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type { ReadonlyDeep, WritableDeep } from 'type-fest';
|
|
2
|
-
import type {
|
|
3
|
-
import type {
|
|
4
|
-
import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
|
|
2
|
+
import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
|
|
3
|
+
import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
|
|
5
4
|
import type { Parameters } from '../../types/typeAliases';
|
|
6
5
|
import type { string_parameter_name } from '../../types/typeAliases';
|
|
7
6
|
import type { TODO_string } from '../../utils/organization/TODO_string';
|
|
7
|
+
import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
|
|
8
8
|
import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
|
|
9
9
|
/**
|
|
10
10
|
* @@@
|
|
@@ -25,7 +25,7 @@ export type ExecuteAttemptsOptions = Omit<CreatePipelineExecutorOptions, 'pipeli
|
|
|
25
25
|
*
|
|
26
26
|
* Note: [💂] There are two distinct variabiles
|
|
27
27
|
* 1) `maxExecutionAttempts` - the amount of attempts LLM model
|
|
28
|
-
* 2) `maxAttempts` - the amount of attempts for any
|
|
28
|
+
* 2) `maxAttempts` - the amount of attempts for any task - LLM, SCRIPT, DIALOG, etc.
|
|
29
29
|
*/
|
|
30
30
|
readonly maxAttempts: number;
|
|
31
31
|
/**
|
|
@@ -39,7 +39,7 @@ export type ExecuteAttemptsOptions = Omit<CreatePipelineExecutorOptions, 'pipeli
|
|
|
39
39
|
/**
|
|
40
40
|
* @@@
|
|
41
41
|
*/
|
|
42
|
-
readonly
|
|
42
|
+
readonly task: ReadonlyDeep<TaskJson>;
|
|
43
43
|
/**
|
|
44
44
|
* @@@
|
|
45
45
|
*/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { ReadonlyDeep } from 'type-fest';
|
|
2
2
|
import { PipelineExecutionError } from '../../errors/PipelineExecutionError';
|
|
3
|
-
import type { PipelineJson } from '../../
|
|
3
|
+
import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
|
|
4
4
|
import type { Parameters } from '../../types/typeAliases';
|
|
5
5
|
/**
|
|
6
6
|
* @@@
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { ReadonlyDeep } from 'type-fest';
|
|
2
|
-
import type {
|
|
2
|
+
import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
|
|
3
3
|
import type { string_markdown } from '../../types/typeAliases';
|
|
4
4
|
import type { string_parameter_value } from '../../types/typeAliases';
|
|
5
5
|
/**
|
|
@@ -7,4 +7,4 @@ import type { string_parameter_value } from '../../types/typeAliases';
|
|
|
7
7
|
*
|
|
8
8
|
* @private internal utility of `createPipelineExecutor`
|
|
9
9
|
*/
|
|
10
|
-
export declare function
|
|
10
|
+
export declare function getContextForTask(task: ReadonlyDeep<TaskJson>): Promise<string_parameter_value & string_markdown>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { ReadonlyDeep } from 'type-fest';
|
|
2
|
-
import type {
|
|
2
|
+
import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
|
|
3
3
|
import type { string_markdown } from '../../types/typeAliases';
|
|
4
4
|
import type { string_parameter_value } from '../../types/typeAliases';
|
|
5
5
|
/**
|
|
@@ -7,4 +7,4 @@ import type { string_parameter_value } from '../../types/typeAliases';
|
|
|
7
7
|
*
|
|
8
8
|
* @private internal utility of `createPipelineExecutor`
|
|
9
9
|
*/
|
|
10
|
-
export declare function
|
|
10
|
+
export declare function getExamplesForTask(task: ReadonlyDeep<TaskJson>): Promise<string_parameter_value & string_markdown>;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { ReadonlyDeep } from 'type-fest';
|
|
2
|
+
import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
|
|
3
|
+
import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
|
|
4
|
+
import type { string_markdown } from '../../types/typeAliases';
|
|
5
|
+
import type { string_parameter_value } from '../../types/typeAliases';
|
|
6
|
+
/**
|
|
7
|
+
* @@@
|
|
8
|
+
*
|
|
9
|
+
* @private internal type of `getKnowledgeFoTask`
|
|
10
|
+
*/
|
|
11
|
+
type GetKnowledgeForTaskOptions = {
|
|
12
|
+
/**
|
|
13
|
+
* @@@
|
|
14
|
+
*/
|
|
15
|
+
readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
|
|
16
|
+
/**
|
|
17
|
+
* @@@
|
|
18
|
+
*/
|
|
19
|
+
readonly task: ReadonlyDeep<TaskJson>;
|
|
20
|
+
};
|
|
21
|
+
/**
|
|
22
|
+
* @@@
|
|
23
|
+
*
|
|
24
|
+
* @private internal utility of `createPipelineExecutor`
|
|
25
|
+
*/
|
|
26
|
+
export declare function getKnowledgeForTask(options: GetKnowledgeForTaskOptions): Promise<string_parameter_value & string_markdown>;
|
|
27
|
+
export {};
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type { ReadonlyDeep } from 'type-fest';
|
|
2
|
+
import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
|
|
3
|
+
import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
|
|
4
|
+
import type { ReservedParameters } from '../../types/typeAliases';
|
|
5
|
+
/**
|
|
6
|
+
* @@@
|
|
7
|
+
*
|
|
8
|
+
* @private internal type of `getReservedParametersForTask`
|
|
9
|
+
*/
|
|
10
|
+
type GetReservedParametersForTaskOptions = {
|
|
11
|
+
/**
|
|
12
|
+
* @@@
|
|
13
|
+
*/
|
|
14
|
+
readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
|
|
15
|
+
/**
|
|
16
|
+
* @@@
|
|
17
|
+
*/
|
|
18
|
+
readonly task: ReadonlyDeep<TaskJson>;
|
|
19
|
+
/**
|
|
20
|
+
* @@@
|
|
21
|
+
*/
|
|
22
|
+
readonly pipelineIdentification: string;
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* @@@
|
|
26
|
+
*
|
|
27
|
+
* @private internal utility of `createPipelineExecutor`
|
|
28
|
+
*/
|
|
29
|
+
export declare function getReservedParametersForTask(options: GetReservedParametersForTaskOptions): Promise<Readonly<ReservedParameters>>;
|
|
30
|
+
export {};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { ErrorJson } from '../../errors/utils/ErrorJson';
|
|
2
|
-
import type {
|
|
3
|
-
import type {
|
|
2
|
+
import type { Prompt } from '../../types/Prompt';
|
|
3
|
+
import type { PromptResult } from '../PromptResult';
|
|
4
4
|
/**
|
|
5
5
|
* Report of single prompt execution
|
|
6
6
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { string_markdown_text } from '
|
|
2
|
-
import type { string_pipeline_url } from '
|
|
3
|
-
import type { string_semantic_version } from '
|
|
1
|
+
import type { string_markdown_text } from '../../types/typeAliases';
|
|
2
|
+
import type { string_pipeline_url } from '../../types/typeAliases';
|
|
3
|
+
import type { string_semantic_version } from '../../types/typeAliases';
|
|
4
4
|
import type { ExecutionPromptReportJson } from './ExecutionPromptReportJson';
|
|
5
5
|
/**
|
|
6
6
|
* ExecutionReport is result of executing one promptbook
|
|
@@ -35,7 +35,7 @@ export type ExecutionReportJson = {
|
|
|
35
35
|
*/
|
|
36
36
|
readonly description?: string_markdown_text;
|
|
37
37
|
/**
|
|
38
|
-
* Sequence of
|
|
38
|
+
* Sequence of tasks in order which were executed
|
|
39
39
|
*/
|
|
40
40
|
readonly promptExecutions: ReadonlyArray<ExecutionPromptReportJson>;
|
|
41
41
|
};
|
|
@@ -4,3 +4,6 @@
|
|
|
4
4
|
* @private internal index of `...` <- TODO [🏢]
|
|
5
5
|
*/
|
|
6
6
|
export declare const FORMAT_DEFINITIONS: readonly [import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, import("./csv/CsvSettings").CsvSettings, any>];
|
|
7
|
+
/**
|
|
8
|
+
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
9
|
+
*/
|
|
@@ -1,10 +1,13 @@
|
|
|
1
|
-
import type { PipelineInterface } from '../../pipeline/
|
|
1
|
+
import type { PipelineInterface } from '../../pipeline/PipelineInterface/PipelineInterface';
|
|
2
2
|
import type { string_markdown_text } from '../../types/typeAliases';
|
|
3
3
|
import type { string_name } from '../../types/typeAliases';
|
|
4
4
|
import type { string_promptbook_documentation_url } from '../../types/typeAliases';
|
|
5
5
|
import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
|
|
6
6
|
/**
|
|
7
7
|
* @@@
|
|
8
|
+
*
|
|
9
|
+
* Note: [🚉] This is fully serializable as JSON
|
|
10
|
+
* @see https://github.com/webgptorg/promptbook/discussions/172
|
|
8
11
|
*/
|
|
9
12
|
export type AbstractFormfactorDefinition = {
|
|
10
13
|
/**
|
|
@@ -3,11 +3,11 @@
|
|
|
3
3
|
*
|
|
4
4
|
* @public exported from `@promptbook/core`
|
|
5
5
|
*/
|
|
6
|
-
export declare const
|
|
6
|
+
export declare const ChatbotFormfactorDefinition: {
|
|
7
7
|
readonly name: "CHATBOT";
|
|
8
8
|
readonly aliasNames: readonly ["CHAT"];
|
|
9
9
|
readonly description: "@@@";
|
|
10
|
-
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions
|
|
10
|
+
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/174";
|
|
11
11
|
readonly pipelineInterface: {
|
|
12
12
|
readonly inputParameterNames: readonly ["previousTitle", "previousConversationSummary", "userMessage"];
|
|
13
13
|
readonly outputParameterNames: readonly ["title", "conversationSummary", "chatbotResponse"];
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
export declare const GenericFormfactorDefinition: {
|
|
7
7
|
readonly name: "GENERIC";
|
|
8
8
|
readonly description: "@@@";
|
|
9
|
-
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions
|
|
9
|
+
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/173";
|
|
10
10
|
readonly pipelineInterface: {
|
|
11
11
|
readonly inputParameterNames: readonly [];
|
|
12
12
|
readonly outputParameterNames: readonly [];
|