Skip to content

Commit 402979b

Browse files
hejnyhejny
committed
Extract constants.ts from config.ts 
1 parent ff7bf48 commit 402979b

18 files changed

+69
-107
lines changed

‎src/config.ts

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
import { PipelineJson } from './_packages/types.index';
21
import type { CsvSettings } from './formats/csv/CsvSettings';
32
import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
43
import type { string_email, string_name, string_url_image } from './types/typeAliases';
54
import { just } from './utils/organization/just';
6-
import { ExportJsonOptions } from './utils/serialization/exportJson';
75

86
/**
97
* Warning message for the generated sections and files files
@@ -70,25 +68,6 @@ export const LOGO_DARK_SRC: string_url_image = `https://promptbook.studio/_next/
7068
*/
7169
export const DEFAULT_TITLE = `Untitled`;
7270

73-
/**
74-
* Order of keys in the pipeline JSON
75-
*
76-
* @public exported from `@promptbook/core`
77-
*/
78-
export const ORDER_OF_PIPELINE_JSON: ExportJsonOptions<PipelineJson>['order'] = [
79-
'title',
80-
'pipelineUrl',
81-
'bookVersion',
82-
'description',
83-
'formfactorName',
84-
'parameters',
85-
'tasks',
86-
'knowledgeSources',
87-
'knowledgePieces',
88-
'personas',
89-
'preparations',
90-
];
91-
9271
/**
9372
* Warning message for the generated sections and files files
9473
*
@@ -213,27 +192,6 @@ export const DEFAULT_SCRAPE_CACHE_DIRNAME = './.promptbook/scrape-cache';
213192
*/
214193
export const DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME = `index`;
215194

216-
/**
217-
* Nonce which is used for replacing things in strings
218-
*
219-
* @private within the repository
220-
*/
221-
export const REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
222-
223-
/**
224-
* @@@
225-
*
226-
* @private within the repository
227-
*/
228-
export const RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
229-
230-
/**
231-
* @@@
232-
*
233-
* @private within the repository
234-
*/
235-
export const RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
236-
237195
/**
238196
* The thresholds for the relative time in the `moment` NPM package.
239197
*

‎src/constants.ts

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,47 @@
1+
import type { PipelineJson } from './pipeline/PipelineJson/PipelineJson';
2+
import type { ExportJsonOptions } from './utils/serialization/exportJson';
13
import { exportJson } from './utils/serialization/exportJson';
24

5+
/**
6+
* Order of keys in the pipeline JSON
7+
*
8+
* @public exported from `@promptbook/core`
9+
*/
10+
export const ORDER_OF_PIPELINE_JSON: ExportJsonOptions<PipelineJson>['order'] = [
11+
'title',
12+
'pipelineUrl',
13+
'bookVersion',
14+
'description',
15+
'formfactorName',
16+
'parameters',
17+
'tasks',
18+
'knowledgeSources',
19+
'knowledgePieces',
20+
'personas',
21+
'preparations',
22+
];
23+
24+
/**
25+
* Nonce which is used for replacing things in strings
26+
*
27+
* @private within the repository
28+
*/
29+
export const REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
30+
31+
/**
32+
* @@@
33+
*
34+
* @private within the repository
35+
*/
36+
export const RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
37+
38+
/**
39+
* @@@
40+
*
41+
* @private within the repository
42+
*/
43+
export const RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
44+
345
/**
446
* The names of the parameters that are reserved for special purposes
547
*
@@ -22,8 +64,6 @@ export const RESERVED_PARAMETER_NAMES = exportJson({
2264
] as const,
2365
});
2466

25-
26-
2767
/**
2868
* Note: [💞] Ignore a discrepancy between file name and entity name
29-
*/
69+
*/

‎src/conversion/pipelineStringToJsonSync.ts

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,9 @@ import type { ParameterCommand } from '../commands/PARAMETER/ParameterCommand';
44
import { sectionCommandParser } from '../commands/SECTION/sectionCommandParser';
55
import { getParserForCommand } from '../commands/_common/getParserForCommand';
66
import { parseCommand } from '../commands/_common/parseCommand';
7-
import type {
8-
$PipelineJson,
9-
$TaskJson,
10-
CommandBase,
11-
PipelineHeadCommandParser,
12-
PipelineTaskCommandParser,
13-
} from '../commands/_common/types/CommandParser';
14-
import { DEFAULT_TITLE, ORDER_OF_PIPELINE_JSON } from '../config';
15-
import { RESERVED_PARAMETER_NAMES } from '../constants';
7+
import type { $PipelineJson, $TaskJson, CommandBase, PipelineHeadCommandParser, PipelineTaskCommandParser } from '../commands/_common/types/CommandParser';
8+
import { DEFAULT_TITLE } from '../config';
9+
import { ORDER_OF_PIPELINE_JSON, RESERVED_PARAMETER_NAMES } from '../constants';
1610
import { ParseError } from '../errors/ParseError';
1711
import { UnexpectedError } from '../errors/UnexpectedError';
1812
import { FORMFACTOR_DEFINITIONS } from '../formfactors/index';

‎src/conversion/utils/stringifyPipelineJson.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import spaceTrim from 'spacetrim';
22
import { LOOP_LIMIT } from '../../config';
3-
import { REPLACING_NONCE } from '../../config';
3+
import { REPLACING_NONCE } from '../../constants';
44
import { UnexpectedError } from '../../errors/UnexpectedError';
55
import type { string_json } from '../../types/typeAliases';
66
import { isSerializableAsJson } from '../../utils/serialization/isSerializableAsJson';

‎src/execution/createPipelineExecutor/10-executePipeline.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { spaceTrim } from 'spacetrim';
22
import type { Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
33
import { forTime } from 'waitasecond';
44
import { IMMEDIATE_TIME, LOOP_LIMIT } from '../../config';
5+
import { RESERVED_PARAMETER_NAMES } from '../../constants';
56
import { PipelineExecutionError } from '../../errors/PipelineExecutionError';
67
import { UnexpectedError } from '../../errors/UnexpectedError';
78
import { serializeError } from '../../errors/utils/serializeError';
@@ -19,7 +20,6 @@ import { ZERO_USAGE } from '../utils/usage-constants';
1920
import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
2021
import { executeTask } from './20-executeTask';
2122
import { filterJustOutputParameters } from './filterJustOutputParameters';
22-
import { RESERVED_PARAMETER_NAMES } from '../../constants';
2323

2424
/**
2525
* @@@

‎src/execution/createPipelineExecutor/getContextForTask.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
import type { ReadonlyDeep } from 'type-fest';
2-
import { RESERVED_PARAMETER_MISSING_VALUE } from '../../config';
2+
import { RESERVED_PARAMETER_MISSING_VALUE } from '../../constants';
33
import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
4-
import type { string_markdown } from '../../types/typeAliases';
5-
import type { string_parameter_value } from '../../types/typeAliases';
4+
import type { string_markdown, string_parameter_value } from '../../types/typeAliases';
65
import { TODO_USE } from '../../utils/organization/TODO_USE';
76

87
/**

‎src/execution/createPipelineExecutor/getExamplesForTask.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
import type { ReadonlyDeep } from 'type-fest';
2-
import { RESERVED_PARAMETER_MISSING_VALUE } from '../../config';
2+
import { RESERVED_PARAMETER_MISSING_VALUE } from '../../constants';
33
import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
4-
import type { string_markdown } from '../../types/typeAliases';
5-
import type { string_parameter_value } from '../../types/typeAliases';
4+
import type { string_markdown, string_parameter_value } from '../../types/typeAliases';
65
import { TODO_USE } from '../../utils/organization/TODO_USE';
76

87
/**

‎src/execution/createPipelineExecutor/getReservedParametersForTask.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
import { spaceTrim } from 'spacetrim';
22
import type { ReadonlyDeep } from 'type-fest';
3-
import { RESERVED_PARAMETER_MISSING_VALUE } from '../../config';
4-
import { RESERVED_PARAMETER_NAMES } from '../../constants';
5-
import { RESERVED_PARAMETER_RESTRICTED } from '../../config';
3+
import { RESERVED_PARAMETER_MISSING_VALUE, RESERVED_PARAMETER_NAMES, RESERVED_PARAMETER_RESTRICTED } from '../../constants';
64
import { UnexpectedError } from '../../errors/UnexpectedError';
75
import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
86
import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';

‎src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.ts

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,7 @@ import type { AvailableModel } from '../../execution/AvailableModel';
99
import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
1010
import type { ChatPromptResult } from '../../execution/PromptResult';
1111
import type { Prompt } from '../../types/Prompt';
12-
import type {
13-
string_date_iso8601,
14-
string_markdown,
15-
string_markdown_text,
16-
string_model_name,
17-
string_title,
18-
} from '../../types/typeAliases';
12+
import type { string_date_iso8601, string_markdown, string_markdown_text, string_model_name, string_title } from '../../types/typeAliases';
1913
import { $getCurrentDate } from '../../utils/$getCurrentDate';
2014
import type { really_any } from '../../utils/organization/really_any';
2115
import { replaceParameters } from '../../utils/parameters/replaceParameters';

‎src/llm-providers/azure-openai/AzureOpenAiExecutionTools.ts

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,10 @@ import { UnexpectedError } from '../../errors/UnexpectedError';
66
import type { AvailableModel } from '../../execution/AvailableModel';
77
import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
88
import type { ChatPromptResult, CompletionPromptResult } from '../../execution/PromptResult';
9-
import type { PromptResultUsage } from '../../execution/PromptResultUsage';
109
import { computeUsageCounts } from '../../execution/utils/computeUsageCounts';
1110
import { uncertainNumber } from '../../execution/utils/uncertainNumber';
1211
import type { Prompt } from '../../types/Prompt';
13-
import type {
14-
string_completion_prompt,
15-
string_date_iso8601,
16-
string_markdown,
17-
string_markdown_text,
18-
string_title,
19-
} from '../../types/typeAliases';
12+
import type { string_completion_prompt, string_date_iso8601, string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
2013
import { $getCurrentDate } from '../../utils/$getCurrentDate';
2114
import { replaceParameters } from '../../utils/parameters/replaceParameters';
2215
import { exportJson } from '../../utils/serialization/exportJson';

‎src/llm-providers/mocked/MockedFackedLlmExecutionTools.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import type { AvailableModel } from '../../execution/AvailableModel';
22
import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
3-
import type { EmbeddingVector } from '../../execution/EmbeddingVector';
43
import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
54
import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult } from '../../execution/PromptResult';
65
import { ZERO_USAGE } from '../../execution/utils/usage-constants';

‎src/llm-providers/openai/OpenAiAssistantExecutionTools.ts

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,7 @@ import type { ChatPromptResult } from '../../execution/PromptResult';
77
import { UNCERTAIN_USAGE } from '../../execution/utils/usage-constants';
88
import type { ModelRequirements } from '../../types/ModelRequirements';
99
import type { Prompt } from '../../types/Prompt';
10-
import type {
11-
string_date_iso8601,
12-
string_markdown,
13-
string_markdown_text,
14-
string_title,
15-
string_token,
16-
} from '../../types/typeAliases';
10+
import type { string_date_iso8601, string_markdown, string_markdown_text, string_title, string_token } from '../../types/typeAliases';
1711
import { $getCurrentDate } from '../../utils/$getCurrentDate';
1812
import { replaceParameters } from '../../utils/parameters/replaceParameters';
1913
import { exportJson } from '../../utils/serialization/exportJson';

‎src/llm-providers/openai/OpenAiExecutionTools.ts

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,7 @@ import type { AvailableModel } from '../../execution/AvailableModel';
88
import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
99
import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult } from '../../execution/PromptResult';
1010
import type { Prompt } from '../../types/Prompt';
11-
import type {
12-
string_date_iso8601,
13-
string_markdown,
14-
string_markdown_text,
15-
string_model_name,
16-
string_title,
17-
string_token,
18-
} from '../../types/typeAliases';
11+
import type { string_date_iso8601, string_markdown, string_markdown_text, string_model_name, string_title, string_token } from '../../types/typeAliases';
1912
import { $getCurrentDate } from '../../utils/$getCurrentDate';
2013
import type { really_any } from '../../utils/organization/really_any';
2114
import { replaceParameters } from '../../utils/parameters/replaceParameters';

‎src/prepare/preparePipeline.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
import type { Writable } from 'type-fest';
2-
import { DEFAULT_IS_VERBOSE, DEFAULT_MAX_PARALLEL_COUNT, ORDER_OF_PIPELINE_JSON } from '../config';
2+
import { DEFAULT_IS_VERBOSE, DEFAULT_MAX_PARALLEL_COUNT } from '../config';
3+
import { ORDER_OF_PIPELINE_JSON } from '../constants';
34
import { MissingToolsError } from '../errors/MissingToolsError';
45
import type { ExecutionTools } from '../execution/ExecutionTools';
56
import { forEachAsync } from '../execution/utils/forEachAsync';
67
import { ZERO_USAGE } from '../execution/utils/usage-constants';
7-
import { countTotalUsage } from '../llm-providers/_common/utils/count-total-usage/countTotalUsage';
88
import { joinLlmExecutionTools } from '../llm-providers/multiple/joinLlmExecutionTools';
9+
import { countTotalUsage } from '../llm-providers/_common/utils/count-total-usage/countTotalUsage';
910
import { preparePersona } from '../personas/preparePersona';
1011
import type { PersonaPreparedJson } from '../pipeline/PipelineJson/PersonaJson';
1112
import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';

‎src/prepare/unpreparePipeline.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { ORDER_OF_PIPELINE_JSON } from '../config';
1+
import { ORDER_OF_PIPELINE_JSON } from '../constants';
22
import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
33
import { extractParameterNames } from '../utils/parameters/extractParameterNames';
44
import { exportJson } from '../utils/serialization/exportJson';

‎src/utils/parameters/replaceParameters.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
import { LOOP_LIMIT } from '../../config';
2-
import { RESERVED_PARAMETER_MISSING_VALUE } from '../../config';
3-
import { RESERVED_PARAMETER_RESTRICTED } from '../../config';
2+
import { RESERVED_PARAMETER_MISSING_VALUE, RESERVED_PARAMETER_RESTRICTED } from '../../constants';
43
import { LimitReachedError } from '../../errors/LimitReachedError';
54
import { PipelineExecutionError } from '../../errors/PipelineExecutionError';
65
import { UnexpectedError } from '../../errors/UnexpectedError';
7-
import type { Parameters } from '../../types/typeAliases';
8-
import type { string_template } from '../../types/typeAliases';
6+
import type { Parameters, string_template } from '../../types/typeAliases';
97

108
/**
119
* Replaces parameters in template with values from parameters object

‎src/utils/serialization/checkSerializableAsJson.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import spaceTrim from 'spacetrim';
22
import { UnexpectedError } from '../../errors/UnexpectedError';
33
import type { string_name } from '../../types/typeAliases';
4-
import { really_unknown } from '../organization/really_unknown';
4+
import type { really_unknown } from '../organization/really_unknown';
55

66
/**
77
* Options for the `checkSerializableAsJson` function

‎src/utils/serialization/exportJson.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
import type { JsonArray, JsonObject } from 'type-fest';
2-
import { orderJson, OrderJsonOptions } from '../normalization/orderJson';
3-
import { TODO_any } from '../organization/TODO_any';
2+
import type { OrderJsonOptions } from '../normalization/orderJson';
3+
import { orderJson } from '../normalization/orderJson';
4+
import type { TODO_any } from '../organization/TODO_any';
45
import { $deepFreeze } from './$deepFreeze';
5-
import { checkSerializableAsJson, CheckSerializableAsJsonOptions } from './checkSerializableAsJson';
6+
import type { CheckSerializableAsJsonOptions } from './checkSerializableAsJson';
7+
import { checkSerializableAsJson } from './checkSerializableAsJson';
68
import { deepClone } from './deepClone';
79

810
/**

0 commit comments

Comments
 (0)