@promptbook/markdown-utils 0.80.0 → 0.81.0-6
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 +6 -0
- package/esm/index.es.js +141 -36
- package/esm/index.es.js.map +1 -1
- package/esm/typings/books/index.d.ts +15 -0
- package/esm/typings/src/_packages/core.index.d.ts +2 -6
- package/esm/typings/src/_packages/editable.index.d.ts +10 -0
- package/esm/typings/src/_packages/templates.index.d.ts +4 -0
- package/esm/typings/src/_packages/types.index.d.ts +4 -0
- package/esm/typings/src/_packages/utils.index.d.ts +10 -2
- package/esm/typings/src/config.d.ts +26 -0
- package/esm/typings/src/execution/ExecutionTools.d.ts +7 -0
- package/esm/typings/src/execution/PromptbookFetch.d.ts +5 -0
- package/esm/typings/src/execution/PromptbookFetch.test-type.d.ts +5 -0
- package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts +2 -1
- package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts +2 -1
- package/esm/typings/src/high-level-abstractions/index.d.ts +10 -0
- package/esm/typings/src/other/templates/getBookTemplate.d.ts +12 -0
- package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts +10 -0
- package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts +10 -0
- package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +1 -1
- package/esm/typings/src/scrapers/_common/utils/scraperFetch.d.ts +7 -0
- package/esm/typings/src/utils/editable/types/PipelineEditableSerialized.d.ts +27 -0
- package/esm/typings/src/{conversion → utils/editable}/utils/removePipelineCommand.d.ts +3 -3
- package/esm/typings/src/{conversion → utils/editable}/utils/renamePipelineParameter.d.ts +3 -3
- package/esm/typings/src/{conversion → utils/editable}/utils/stringifyPipelineJson.d.ts +2 -2
- package/esm/typings/src/utils/parameters/numberToString.d.ts +7 -0
- package/esm/typings/src/utils/parameters/{replaceParameters.d.ts → templateParameters.d.ts} +6 -2
- package/esm/typings/src/utils/parameters/valueToString.d.ts +17 -0
- package/esm/typings/src/utils/parameters/valueToString.test.d.ts +1 -0
- package/esm/typings/src/utils/serialization/asSerializable.d.ts +4 -0
- package/package.json +1 -1
- package/umd/index.umd.js +141 -36
- package/umd/index.umd.js.map +1 -1
- package/esm/typings/src/utils/formatNumber.d.ts +0 -6
- /package/esm/typings/src/{conversion → utils/editable}/utils/removePipelineCommand.test.d.ts +0 -0
- /package/esm/typings/src/{conversion → utils/editable}/utils/renamePipelineParameter.test.d.ts +0 -0
- /package/esm/typings/src/{conversion → utils/editable}/utils/stringifyPipelineJson.test.d.ts +0 -0
- /package/esm/typings/src/utils/{formatNumber.test.d.ts → parameters/numberToString.test.d.ts} +0 -0
- /package/esm/typings/src/utils/parameters/{replaceParameters.test.d.ts → templateParameters.test.d.ts} +0 -0
|
@@ -20,6 +20,11 @@ declare const _default: ({
|
|
|
20
20
|
preparations: never[];
|
|
21
21
|
knowledgeSources: never[];
|
|
22
22
|
knowledgePieces: never[];
|
|
23
|
+
sources: {
|
|
24
|
+
type: string;
|
|
25
|
+
path: null;
|
|
26
|
+
content: string;
|
|
27
|
+
}[];
|
|
23
28
|
sourceFile: string;
|
|
24
29
|
} | {
|
|
25
30
|
title: string;
|
|
@@ -49,6 +54,11 @@ declare const _default: ({
|
|
|
49
54
|
preparations: never[];
|
|
50
55
|
knowledgeSources: never[];
|
|
51
56
|
knowledgePieces: never[];
|
|
57
|
+
sources: {
|
|
58
|
+
type: string;
|
|
59
|
+
path: null;
|
|
60
|
+
content: string;
|
|
61
|
+
}[];
|
|
52
62
|
sourceFile: string;
|
|
53
63
|
} | {
|
|
54
64
|
title: string;
|
|
@@ -73,6 +83,11 @@ declare const _default: ({
|
|
|
73
83
|
preparations: never[];
|
|
74
84
|
knowledgeSources: never[];
|
|
75
85
|
knowledgePieces: never[];
|
|
86
|
+
sources: {
|
|
87
|
+
type: string;
|
|
88
|
+
path: null;
|
|
89
|
+
content: string;
|
|
90
|
+
}[];
|
|
76
91
|
sourceFile: string;
|
|
77
92
|
})[];
|
|
78
93
|
export default _default;
|
|
@@ -27,6 +27,7 @@ import { DEFAULT_CSV_SETTINGS } from '../config';
|
|
|
27
27
|
import { DEFAULT_IS_VERBOSE } from '../config';
|
|
28
28
|
import { SET_IS_VERBOSE } from '../config';
|
|
29
29
|
import { DEFAULT_IS_AUTO_INSTALLED } from '../config';
|
|
30
|
+
import { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME } from '../config';
|
|
30
31
|
import { ORDER_OF_PIPELINE_JSON } from '../constants';
|
|
31
32
|
import { RESERVED_PARAMETER_NAMES } from '../constants';
|
|
32
33
|
import { compilePipeline } from '../conversion/compilePipeline';
|
|
@@ -34,9 +35,6 @@ import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
|
|
|
34
35
|
import { precompilePipeline } from '../conversion/precompilePipeline';
|
|
35
36
|
import { prettifyPipelineString } from '../conversion/prettify/prettifyPipelineString';
|
|
36
37
|
import { extractParameterNamesFromTask } from '../conversion/utils/extractParameterNamesFromTask';
|
|
37
|
-
import { removePipelineCommand } from '../conversion/utils/removePipelineCommand';
|
|
38
|
-
import { renamePipelineParameter } from '../conversion/utils/renamePipelineParameter';
|
|
39
|
-
import { stringifyPipelineJson } from '../conversion/utils/stringifyPipelineJson';
|
|
40
38
|
import { validatePipeline } from '../conversion/validation/validatePipeline';
|
|
41
39
|
import { CallbackInterfaceTools } from '../dialogs/callback/CallbackInterfaceTools';
|
|
42
40
|
import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';
|
|
@@ -148,6 +146,7 @@ export { DEFAULT_CSV_SETTINGS };
|
|
|
148
146
|
export { DEFAULT_IS_VERBOSE };
|
|
149
147
|
export { SET_IS_VERBOSE };
|
|
150
148
|
export { DEFAULT_IS_AUTO_INSTALLED };
|
|
149
|
+
export { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME };
|
|
151
150
|
export { ORDER_OF_PIPELINE_JSON };
|
|
152
151
|
export { RESERVED_PARAMETER_NAMES };
|
|
153
152
|
export { compilePipeline };
|
|
@@ -155,9 +154,6 @@ export { pipelineJsonToString };
|
|
|
155
154
|
export { precompilePipeline };
|
|
156
155
|
export { prettifyPipelineString };
|
|
157
156
|
export { extractParameterNamesFromTask };
|
|
158
|
-
export { removePipelineCommand };
|
|
159
|
-
export { renamePipelineParameter };
|
|
160
|
-
export { stringifyPipelineJson };
|
|
161
157
|
export { validatePipeline };
|
|
162
158
|
export { CallbackInterfaceTools };
|
|
163
159
|
export type { CallbackInterfaceToolsOptions };
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
|
|
2
|
+
import type { PipelineEditableSerialized } from '../utils/editable/types/PipelineEditableSerialized';
|
|
3
|
+
import { removePipelineCommand } from '../utils/editable/utils/removePipelineCommand';
|
|
4
|
+
import { renamePipelineParameter } from '../utils/editable/utils/renamePipelineParameter';
|
|
5
|
+
import { stringifyPipelineJson } from '../utils/editable/utils/stringifyPipelineJson';
|
|
6
|
+
export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
|
|
7
|
+
export type { PipelineEditableSerialized };
|
|
8
|
+
export { removePipelineCommand };
|
|
9
|
+
export { renamePipelineParameter };
|
|
10
|
+
export { stringifyPipelineJson };
|
|
@@ -30,6 +30,7 @@ import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
|
|
|
30
30
|
import type { LlmExecutionToolsConstructor } from '../execution/LlmExecutionToolsConstructor';
|
|
31
31
|
import type { PipelineExecutor } from '../execution/PipelineExecutor';
|
|
32
32
|
import type { PipelineExecutorResult } from '../execution/PipelineExecutorResult';
|
|
33
|
+
import type { PromptbookFetch } from '../execution/PromptbookFetch';
|
|
33
34
|
import type { PromptResult } from '../execution/PromptResult';
|
|
34
35
|
import type { CompletionPromptResult } from '../execution/PromptResult';
|
|
35
36
|
import type { ChatPromptResult } from '../execution/PromptResult';
|
|
@@ -241,6 +242,7 @@ import type { number_gigabytes } from '../types/typeAliases';
|
|
|
241
242
|
import type { number_terabytes } from '../types/typeAliases';
|
|
242
243
|
import type { Registered } from '../utils/$Register';
|
|
243
244
|
import type { Registration } from '../utils/$Register';
|
|
245
|
+
import type { PipelineEditableSerialized } from '../utils/editable/types/PipelineEditableSerialized';
|
|
244
246
|
import type { ExecCommandOptions } from '../utils/execCommand/ExecCommandOptions';
|
|
245
247
|
import type { ExecCommandOptionsAdvanced } from '../utils/execCommand/ExecCommandOptions';
|
|
246
248
|
import type { FromtoItems } from '../utils/FromtoItems';
|
|
@@ -292,6 +294,7 @@ export type { LlmExecutionTools };
|
|
|
292
294
|
export type { LlmExecutionToolsConstructor };
|
|
293
295
|
export type { PipelineExecutor };
|
|
294
296
|
export type { PipelineExecutorResult };
|
|
297
|
+
export type { PromptbookFetch };
|
|
295
298
|
export type { PromptResult };
|
|
296
299
|
export type { CompletionPromptResult };
|
|
297
300
|
export type { ChatPromptResult };
|
|
@@ -503,6 +506,7 @@ export type { number_gigabytes };
|
|
|
503
506
|
export type { number_terabytes };
|
|
504
507
|
export type { Registered };
|
|
505
508
|
export type { Registration };
|
|
509
|
+
export type { PipelineEditableSerialized };
|
|
506
510
|
export type { ExecCommandOptions };
|
|
507
511
|
export type { ExecCommandOptionsAdvanced };
|
|
508
512
|
export type { FromtoItems };
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
|
|
2
|
+
import { VALUE_STRINGS } from '../config';
|
|
3
|
+
import { SMALL_NUMBER } from '../config';
|
|
2
4
|
import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMermaidOptions';
|
|
3
5
|
import { extractVariablesFromScript } from '../conversion/utils/extractVariablesFromScript';
|
|
4
6
|
import { deserializeError } from '../errors/utils/deserializeError';
|
|
@@ -46,7 +48,9 @@ import { searchKeywords } from '../utils/normalization/searchKeywords';
|
|
|
46
48
|
import { titleToName } from '../utils/normalization/titleToName';
|
|
47
49
|
import { spaceTrim } from '../utils/organization/spaceTrim';
|
|
48
50
|
import { extractParameterNames } from '../utils/parameters/extractParameterNames';
|
|
49
|
-
import {
|
|
51
|
+
import { numberToString } from '../utils/parameters/numberToString';
|
|
52
|
+
import { templateParameters } from '../utils/parameters/templateParameters';
|
|
53
|
+
import { valueToString } from '../utils/parameters/valueToString';
|
|
50
54
|
import { parseNumber } from '../utils/parseNumber';
|
|
51
55
|
import { $randomSeed } from '../utils/random/$randomSeed';
|
|
52
56
|
import { removeEmojis } from '../utils/removeEmojis';
|
|
@@ -74,6 +78,8 @@ import { isValidPipelineUrl } from '../utils/validators/url/isValidPipelineUrl';
|
|
|
74
78
|
import { isValidUrl } from '../utils/validators/url/isValidUrl';
|
|
75
79
|
import { isValidUuid } from '../utils/validators/uuid/isValidUuid';
|
|
76
80
|
export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
|
|
81
|
+
export { VALUE_STRINGS };
|
|
82
|
+
export { SMALL_NUMBER };
|
|
77
83
|
export { renderPromptbookMermaid };
|
|
78
84
|
export { extractVariablesFromScript };
|
|
79
85
|
export { deserializeError };
|
|
@@ -121,7 +127,9 @@ export { searchKeywords };
|
|
|
121
127
|
export { titleToName };
|
|
122
128
|
export { spaceTrim };
|
|
123
129
|
export { extractParameterNames };
|
|
124
|
-
export {
|
|
130
|
+
export { numberToString };
|
|
131
|
+
export { templateParameters };
|
|
132
|
+
export { valueToString };
|
|
125
133
|
export { parseNumber };
|
|
126
134
|
export { $randomSeed };
|
|
127
135
|
export { removeEmojis };
|
|
@@ -77,6 +77,26 @@ export declare const LOOP_LIMIT = 1000;
|
|
|
77
77
|
* @private within the repository - too low-level in comparison with other `MAX_...`
|
|
78
78
|
*/
|
|
79
79
|
export declare const CHARACTER_LOOP_LIMIT = 100000;
|
|
80
|
+
/**
|
|
81
|
+
* Strings to represent various values in the context of parameter values
|
|
82
|
+
*
|
|
83
|
+
* @public exported from `@promptbook/utils`
|
|
84
|
+
*/
|
|
85
|
+
export declare const VALUE_STRINGS: {
|
|
86
|
+
readonly empty: "(nothing; empty string)";
|
|
87
|
+
readonly null: "(no value; null)";
|
|
88
|
+
readonly undefined: "(unknown value; undefined)";
|
|
89
|
+
readonly nan: "(not a number; NaN)";
|
|
90
|
+
readonly infinity: "(infinity; ∞)";
|
|
91
|
+
readonly negativeInfinity: "(negative infinity; -∞)";
|
|
92
|
+
readonly unserializable: "(unserializable value)";
|
|
93
|
+
};
|
|
94
|
+
/**
|
|
95
|
+
* Small number limit
|
|
96
|
+
*
|
|
97
|
+
* @public exported from `@promptbook/utils`
|
|
98
|
+
*/
|
|
99
|
+
export declare const SMALL_NUMBER = 0.001;
|
|
80
100
|
/**
|
|
81
101
|
* Timeout for the connections in milliseconds
|
|
82
102
|
*
|
|
@@ -209,6 +229,12 @@ export declare function SET_IS_VERBOSE(isVerbose: boolean): void;
|
|
|
209
229
|
* @public exported from `@promptbook/core`
|
|
210
230
|
*/
|
|
211
231
|
export declare const DEFAULT_IS_AUTO_INSTALLED = false;
|
|
232
|
+
/**
|
|
233
|
+
* Function name for generated function via `ptbk make` to get the pipeline collection
|
|
234
|
+
*
|
|
235
|
+
* @public exported from `@promptbook/core`
|
|
236
|
+
*/
|
|
237
|
+
export declare const DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME = "getPipelineCollection";
|
|
212
238
|
/**
|
|
213
239
|
* @@@
|
|
214
240
|
*
|
|
@@ -3,6 +3,7 @@ import type { Arrayable } from '../types/Arrayable';
|
|
|
3
3
|
import type { Executables } from './Executables';
|
|
4
4
|
import type { FilesystemTools } from './FilesystemTools';
|
|
5
5
|
import type { LlmExecutionTools } from './LlmExecutionTools';
|
|
6
|
+
import type { PromptbookFetch } from './PromptbookFetch';
|
|
6
7
|
import type { ScriptExecutionTools } from './ScriptExecutionTools';
|
|
7
8
|
import type { UserInterfaceTools } from './UserInterfaceTools';
|
|
8
9
|
/**
|
|
@@ -27,6 +28,12 @@ export type ExecutionTools = {
|
|
|
27
28
|
* @default undefined - If not provided, no filesystem operations will be possible
|
|
28
29
|
*/
|
|
29
30
|
readonly fs?: FilesystemTools;
|
|
31
|
+
/**
|
|
32
|
+
* Fetch function for fetching resources
|
|
33
|
+
*
|
|
34
|
+
* @default `fetch` - If not provided, the built-in `fetch' function is used with a lightweight error handling wrapper.
|
|
35
|
+
*/
|
|
36
|
+
readonly fetch?: PromptbookFetch;
|
|
30
37
|
/**
|
|
31
38
|
* Scrapers for extracting knowledge from external sources
|
|
32
39
|
*
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
+
import type { PromptbookFetch } from '../../execution/PromptbookFetch';
|
|
1
2
|
import type { string_name } from '../../types/typeAliases';
|
|
2
3
|
/**
|
|
3
4
|
* @private still in development
|
|
4
5
|
*/
|
|
5
|
-
export declare function isDomainNameFree(name: string_name): Promise<boolean>;
|
|
6
|
+
export declare function isDomainNameFree(name: string_name, fetch: PromptbookFetch): Promise<boolean>;
|
|
6
7
|
/**
|
|
7
8
|
* TODO: [🍓][🧠] Test and implement `isDomainNameFree`
|
|
8
9
|
* TODO: Export via some (and probably new) NPM package
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
+
import type { PromptbookFetch } from '../../execution/PromptbookFetch';
|
|
1
2
|
import type { string_name } from '../../types/typeAliases';
|
|
2
3
|
/**
|
|
3
4
|
* @private still in development
|
|
4
5
|
*/
|
|
5
|
-
export declare function isGithubNameFree(name: string_name): Promise<boolean>;
|
|
6
|
+
export declare function isGithubNameFree(name: string_name, fetch: PromptbookFetch): Promise<boolean>;
|
|
6
7
|
/**
|
|
7
8
|
* TODO: [🍓][🧠] Test and implement `isGithubNameFree`
|
|
8
9
|
* TODO: Export via some (and probably new) NPM package
|
|
@@ -18,6 +18,11 @@ export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
|
|
|
18
18
|
readonly knowledgePieces: import("../_packages/types.index").KnowledgePiecePreparedJson[];
|
|
19
19
|
readonly personas: (import("../_packages/types.index").PersonaJson | import("../_packages/types.index").PersonaPreparedJson)[];
|
|
20
20
|
readonly preparations: import("../_packages/types.index").PreparationJson[];
|
|
21
|
+
readonly sources: readonly {
|
|
22
|
+
type: "BOOK";
|
|
23
|
+
path: string | null;
|
|
24
|
+
content: import("../pipeline/PipelineString").PipelineString;
|
|
25
|
+
}[];
|
|
21
26
|
readonly formfactorName?: "CHATBOT" | "GENERATOR" | "GENERIC" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
|
|
22
27
|
}>): void;
|
|
23
28
|
}, {
|
|
@@ -35,6 +40,11 @@ export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
|
|
|
35
40
|
readonly knowledgePieces: import("../_packages/types.index").KnowledgePiecePreparedJson[];
|
|
36
41
|
readonly personas: (import("../_packages/types.index").PersonaJson | import("../_packages/types.index").PersonaPreparedJson)[];
|
|
37
42
|
readonly preparations: import("../_packages/types.index").PreparationJson[];
|
|
43
|
+
readonly sources: readonly {
|
|
44
|
+
type: "BOOK";
|
|
45
|
+
path: string | null;
|
|
46
|
+
content: import("../pipeline/PipelineString").PipelineString;
|
|
47
|
+
}[];
|
|
38
48
|
readonly formfactorName?: "CHATBOT" | "GENERATOR" | "GENERIC" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
|
|
39
49
|
}>): void;
|
|
40
50
|
}];
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
|
|
2
|
+
import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
|
|
3
|
+
/**
|
|
4
|
+
* Get template for new book
|
|
5
|
+
*
|
|
6
|
+
* @public exported from `@promptbook/templates`
|
|
7
|
+
*/
|
|
8
|
+
export declare function getBookTemplate(formfactorName: string_formfactor_name): Promise<PipelineJson | null>;
|
|
9
|
+
/**
|
|
10
|
+
* TODO: [🧠] Which is the best place for this function
|
|
11
|
+
* TODO: !!!!!! `book string template notation
|
|
12
|
+
*/
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { PipelineCollection } from '../../collection/PipelineCollection';
|
|
2
|
+
/**
|
|
3
|
+
* Get pipeline collection for Untitled Promptbook project
|
|
4
|
+
*
|
|
5
|
+
* ⚠️ WARNING: This code has been generated by `@promptbook/cli` so that any manual changes will be overwritten
|
|
6
|
+
*
|
|
7
|
+
* @generated
|
|
8
|
+
* @returns {PipelineCollection} Library of promptbooks for Untitled Promptbook project
|
|
9
|
+
*/
|
|
10
|
+
export declare function getTemplatesPipelineCollection(): PipelineCollection;
|
|
@@ -3,7 +3,9 @@ import type { ModelRequirements } from '../../types/ModelRequirements';
|
|
|
3
3
|
import type { string_filename } from '../../types/typeAliases';
|
|
4
4
|
import type { string_markdown_text } from '../../types/typeAliases';
|
|
5
5
|
import type { string_pipeline_url } from '../../types/typeAliases';
|
|
6
|
+
import type { string_relative_filename } from '../../types/typeAliases';
|
|
6
7
|
import type { string_semantic_version } from '../../types/typeAliases';
|
|
8
|
+
import type { PipelineString } from '../PipelineString';
|
|
7
9
|
import type { KnowledgePiecePreparedJson } from './KnowledgePieceJson';
|
|
8
10
|
import type { KnowledgeSourceJson } from './KnowledgeSourceJson';
|
|
9
11
|
import type { KnowledgeSourcePreparedJson } from './KnowledgeSourceJson';
|
|
@@ -91,6 +93,14 @@ export type PipelineJson = {
|
|
|
91
93
|
* @see https://github.com/webgptorg/promptbook/discussions/78
|
|
92
94
|
*/
|
|
93
95
|
readonly preparations: Array<PreparationJson>;
|
|
96
|
+
/**
|
|
97
|
+
* Backup of the original book source
|
|
98
|
+
*/
|
|
99
|
+
readonly sources: ReadonlyArray<{
|
|
100
|
+
type: 'BOOK';
|
|
101
|
+
path: string_relative_filename | null;
|
|
102
|
+
content: PipelineString;
|
|
103
|
+
}>;
|
|
94
104
|
};
|
|
95
105
|
/**
|
|
96
106
|
* TODO: [🛳] Default PERSONA for the pipeline `defaultPersonaName` (same as `defaultModelRequirements`)
|
|
@@ -8,4 +8,4 @@ import type { ScraperSourceHandler } from '../Scraper';
|
|
|
8
8
|
*
|
|
9
9
|
* @public exported from `@promptbook/core`
|
|
10
10
|
*/
|
|
11
|
-
export declare function makeKnowledgeSourceHandler(knowledgeSource: SetOptional<KnowledgeSourceJson, 'name'>, tools: Pick<ExecutionTools, 'fs'>, options?: Pick<PrepareAndScrapeOptions, 'rootDirname' | 'isVerbose'>): Promise<ScraperSourceHandler>;
|
|
11
|
+
export declare function makeKnowledgeSourceHandler(knowledgeSource: SetOptional<KnowledgeSourceJson, 'name'>, tools: Pick<ExecutionTools, 'fs' | 'fetch'>, options?: Pick<PrepareAndScrapeOptions, 'rootDirname' | 'isVerbose'>): Promise<ScraperSourceHandler>;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { PromptbookFetch } from '../../../execution/PromptbookFetch';
|
|
2
|
+
/**
|
|
3
|
+
* The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
|
|
4
|
+
*
|
|
5
|
+
* @private as default `fetch` function used in Promptbook scrapers
|
|
6
|
+
*/
|
|
7
|
+
export declare const scraperFetch: PromptbookFetch;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { ErrorJson } from '../../../errors/utils/ErrorJson';
|
|
2
|
+
import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
|
|
3
|
+
import type { string_date_iso8601 } from '../../../types/typeAliases';
|
|
4
|
+
/**
|
|
5
|
+
* Represents a single pipeline in PromptbookStudio
|
|
6
|
+
*
|
|
7
|
+
* This is simple extension of PipelineJson with additional metadata
|
|
8
|
+
* Note: There are two similar entities:
|
|
9
|
+
* 1) Type (interface) `PipelineEditableSerialized` which represents just data in database
|
|
10
|
+
* 2) Class `PipelineEditable` which implements `PipelineEditableSerialized` and adds error handling and editing capabilities
|
|
11
|
+
*
|
|
12
|
+
* @public exported from `@promptbook/editable`
|
|
13
|
+
*/
|
|
14
|
+
export type PipelineEditableSerialized = PipelineJson & {
|
|
15
|
+
/**
|
|
16
|
+
* When was the pipeline created
|
|
17
|
+
*/
|
|
18
|
+
readonly createdAt: string_date_iso8601;
|
|
19
|
+
/**
|
|
20
|
+
* When was the pipeline last modified
|
|
21
|
+
*/
|
|
22
|
+
readonly updatedAt: string_date_iso8601 | null;
|
|
23
|
+
/**
|
|
24
|
+
* Known errors to transfer to new PipelineEditable
|
|
25
|
+
*/
|
|
26
|
+
readonly knownErrors: Array<ErrorJson>;
|
|
27
|
+
};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { CommandType } from '
|
|
2
|
-
import type { PipelineString } from '
|
|
1
|
+
import type { CommandType } from '../../../commands/_common/types/CommandType';
|
|
2
|
+
import type { PipelineString } from '../../../pipeline/PipelineString';
|
|
3
3
|
/**
|
|
4
4
|
* Options for `removePipelineCommand`
|
|
5
5
|
*/
|
|
@@ -16,7 +16,7 @@ type RemovePipelineCommandOptions = {
|
|
|
16
16
|
/**
|
|
17
17
|
* Function `removePipelineCommand` will remove one command from pipeline string
|
|
18
18
|
*
|
|
19
|
-
* @public exported from `@promptbook/
|
|
19
|
+
* @public exported from `@promptbook/editable`
|
|
20
20
|
*/
|
|
21
21
|
export declare function removePipelineCommand(options: RemovePipelineCommandOptions): PipelineString;
|
|
22
22
|
export {};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { PipelineJson } from '
|
|
2
|
-
import type { string_name } from '
|
|
1
|
+
import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
|
|
2
|
+
import type { string_name } from '../../../types/typeAliases';
|
|
3
3
|
type RenameParameterOptions = {
|
|
4
4
|
/**
|
|
5
5
|
* Pipeline to search and replace for parameters
|
|
@@ -20,7 +20,7 @@ type RenameParameterOptions = {
|
|
|
20
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
|
-
* @public exported from `@promptbook/
|
|
23
|
+
* @public exported from `@promptbook/editable`
|
|
24
24
|
*/
|
|
25
25
|
export declare function renamePipelineParameter(options: RenameParameterOptions): PipelineJson;
|
|
26
26
|
export {};
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import type { string_json } from '
|
|
1
|
+
import type { string_json } from '../../../types/typeAliases';
|
|
2
2
|
/**
|
|
3
3
|
* Stringify the PipelineJson with proper formatting
|
|
4
4
|
*
|
|
5
5
|
* Note: [0] It can be used for more JSON types like whole collection of pipelines, single knowledge piece, etc.
|
|
6
6
|
* Note: In contrast to JSON.stringify, this function ensures that **embedding index** is on single line
|
|
7
7
|
*
|
|
8
|
-
* @public exported from `@promptbook/
|
|
8
|
+
* @public exported from `@promptbook/editable`
|
|
9
9
|
*/
|
|
10
10
|
export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
|
|
11
11
|
/**
|
|
@@ -1,12 +1,16 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { string_parameter_name } from '../../types/typeAliases';
|
|
2
2
|
import type { string_template } from '../../types/typeAliases';
|
|
3
|
+
import type { really_unknown } from '../organization/really_unknown';
|
|
3
4
|
/**
|
|
4
5
|
* Replaces parameters in template with values from parameters object
|
|
5
6
|
*
|
|
7
|
+
* Note: This function is not places strings into string,
|
|
8
|
+
* It's more complex and can handle this operation specifically for LLM models
|
|
9
|
+
*
|
|
6
10
|
* @param template the template with parameters in {curly} braces
|
|
7
11
|
* @param parameters the object with parameters
|
|
8
12
|
* @returns the template with replaced parameters
|
|
9
13
|
* @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
|
|
10
14
|
* @public exported from `@promptbook/utils`
|
|
11
15
|
*/
|
|
12
|
-
export declare function
|
|
16
|
+
export declare function templateParameters(template: string_template, parameters: Record<string_parameter_name, really_unknown>): string;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { string_parameter_value } from '../../types/typeAliases';
|
|
2
|
+
import type { really_unknown } from '../organization/really_unknown';
|
|
3
|
+
/**
|
|
4
|
+
* Function `valueToString` will convert the given value to string
|
|
5
|
+
* This is useful and used in the `templateParameters` function
|
|
6
|
+
*
|
|
7
|
+
* Note: This function is not just calling `toString` method
|
|
8
|
+
* It's more complex and can handle this conversion specifically for LLM models
|
|
9
|
+
* See `VALUE_STRINGS`
|
|
10
|
+
*
|
|
11
|
+
* Note: There are 2 similar functions
|
|
12
|
+
* - `valueToString` converts value to string for LLM models as human-readable string
|
|
13
|
+
* - `asSerializable` converts value to string to preserve full information to be able to convert it back
|
|
14
|
+
*
|
|
15
|
+
* @public exported from `@promptbook/utils`
|
|
16
|
+
*/
|
|
17
|
+
export declare function valueToString(value: really_unknown): string_parameter_value;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -6,6 +6,10 @@ import type { really_any } from '../organization/really_any';
|
|
|
6
6
|
* For example:
|
|
7
7
|
* - `Date` objects will be converted to string
|
|
8
8
|
*
|
|
9
|
+
* Note: There are 2 similar functions
|
|
10
|
+
* - `valueToString` converts value to string for LLM models as human-readable string
|
|
11
|
+
* - `asSerializable` converts value to string to preserve full information to be able to convert it back
|
|
12
|
+
*
|
|
9
13
|
* @private Internal helper function
|
|
10
14
|
*/
|
|
11
15
|
export declare function asSerializable(value: really_any): really_any;
|
package/package.json
CHANGED