@promptbook/markdown-utils 0.88.0 → 0.89.0-11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/README.md +7 -1
  2. package/esm/index.es.js +162 -89
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/src/_packages/core.index.d.ts +18 -6
  5. package/esm/typings/src/_packages/remote-client.index.d.ts +6 -8
  6. package/esm/typings/src/_packages/remote-server.index.d.ts +6 -6
  7. package/esm/typings/src/_packages/types.index.d.ts +18 -10
  8. package/esm/typings/src/cli/cli-commands/login.d.ts +15 -0
  9. package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +7 -0
  10. package/esm/typings/src/cli/common/$provideLlmToolsForCli.d.ts +15 -0
  11. package/esm/typings/src/config.d.ts +15 -8
  12. package/esm/typings/src/errors/0-index.d.ts +6 -0
  13. package/esm/typings/src/errors/AuthenticationError.d.ts +9 -0
  14. package/esm/typings/src/errors/PromptbookFetchError.d.ts +9 -0
  15. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +2 -2
  16. package/esm/typings/src/execution/PromptResult.d.ts +2 -2
  17. package/esm/typings/src/execution/{PromptResultUsage.d.ts → Usage.d.ts} +5 -5
  18. package/esm/typings/src/execution/utils/addUsage.d.ts +2 -2
  19. package/esm/typings/src/execution/utils/computeUsageCounts.d.ts +3 -3
  20. package/esm/typings/src/execution/utils/usage-constants.d.ts +77 -60
  21. package/esm/typings/src/execution/utils/usageToHuman.d.ts +5 -5
  22. package/esm/typings/src/execution/utils/usageToWorktime.d.ts +5 -5
  23. package/esm/typings/src/llm-providers/_common/register/$provideEnvFilename.d.ts +12 -0
  24. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +2 -8
  25. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +2 -0
  26. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizzardOrCli.d.ts +36 -1
  27. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +1 -0
  28. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +9 -2
  29. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/{countTotalUsage.d.ts → countUsage.d.ts} +1 -1
  30. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +2 -2
  31. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +1 -1
  32. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts +2 -2
  33. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +1 -1
  34. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +0 -9
  35. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.d.ts +2 -2
  36. package/esm/typings/src/pipeline/PipelineJson/PreparationJson.d.ts +2 -2
  37. package/esm/typings/src/playground/playground.d.ts +5 -0
  38. package/esm/typings/src/remote-server/RemoteServer.d.ts +23 -0
  39. package/esm/typings/src/remote-server/socket-types/_subtypes/{PromptbookServer_Identification.d.ts → Identification.d.ts} +5 -4
  40. package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts +2 -2
  41. package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Request.d.ts +2 -2
  42. package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Request.d.ts +2 -2
  43. package/esm/typings/src/remote-server/startRemoteServer.d.ts +2 -2
  44. package/esm/typings/src/remote-server/types/RemoteClientOptions.d.ts +4 -12
  45. package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts +88 -6
  46. package/esm/typings/src/scrapers/_common/utils/{scraperFetch.d.ts → promptbookFetch.d.ts} +2 -2
  47. package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +37 -0
  48. package/esm/typings/src/types/typeAliases.d.ts +8 -2
  49. package/esm/typings/src/utils/organization/TODO_narrow.d.ts +6 -0
  50. package/package.json +1 -1
  51. package/umd/index.umd.js +162 -89
  52. package/umd/index.umd.js.map +1 -1
@@ -25,9 +25,10 @@ import { DEFAULT_BOOKS_DIRNAME } from '../config';
25
25
  import { DEFAULT_DOWNLOAD_CACHE_DIRNAME } from '../config';
26
26
  import { DEFAULT_EXECUTION_CACHE_DIRNAME } from '../config';
27
27
  import { DEFAULT_SCRAPE_CACHE_DIRNAME } from '../config';
28
+ import { CLI_APP_ID } from '../config';
29
+ import { PLAYGROUND_APP_ID } from '../config';
28
30
  import { DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME } from '../config';
29
- import { DEFAULT_REMOTE_URL } from '../config';
30
- import { DEFAULT_REMOTE_URL_PATH } from '../config';
31
+ import { DEFAULT_REMOTE_SERVER_URL } from '../config';
31
32
  import { DEFAULT_CSV_SETTINGS } from '../config';
32
33
  import { DEFAULT_IS_VERBOSE } from '../config';
33
34
  import { SET_IS_VERBOSE } from '../config';
@@ -46,6 +47,7 @@ import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/Callback
46
47
  import { BoilerplateError } from '../errors/0-BoilerplateError';
47
48
  import { PROMPTBOOK_ERRORS } from '../errors/0-index';
48
49
  import { AbstractFormatError } from '../errors/AbstractFormatError';
50
+ import { AuthenticationError } from '../errors/AuthenticationError';
49
51
  import { CollectionError } from '../errors/CollectionError';
50
52
  import { EnvironmentMismatchError } from '../errors/EnvironmentMismatchError';
51
53
  import { ExpectError } from '../errors/ExpectError';
@@ -58,6 +60,7 @@ import { ParseError } from '../errors/ParseError';
58
60
  import { PipelineExecutionError } from '../errors/PipelineExecutionError';
59
61
  import { PipelineLogicError } from '../errors/PipelineLogicError';
60
62
  import { PipelineUrlError } from '../errors/PipelineUrlError';
63
+ import { PromptbookFetchError } from '../errors/PromptbookFetchError';
61
64
  import { UnexpectedError } from '../errors/UnexpectedError';
62
65
  import { createPipelineExecutor } from '../execution/createPipelineExecutor/00-createPipelineExecutor';
63
66
  import { embeddingVectorToString } from '../execution/embeddingVectorToString';
@@ -66,6 +69,8 @@ import type { ExecutionReportStringOptions } from '../execution/execution-report
66
69
  import { ExecutionReportStringOptionsDefaults } from '../execution/execution-report/ExecutionReportStringOptions';
67
70
  import { addUsage } from '../execution/utils/addUsage';
68
71
  import { isPassingExpectations } from '../execution/utils/checkExpectations';
72
+ import { ZERO_VALUE } from '../execution/utils/usage-constants';
73
+ import { UNCERTAIN_ZERO_VALUE } from '../execution/utils/usage-constants';
69
74
  import { ZERO_USAGE } from '../execution/utils/usage-constants';
70
75
  import { UNCERTAIN_USAGE } from '../execution/utils/usage-constants';
71
76
  import { usageToHuman } from '../execution/utils/usageToHuman';
@@ -87,7 +92,7 @@ import { $llmToolsMetadataRegister } from '../llm-providers/_common/register/$ll
87
92
  import { $llmToolsRegister } from '../llm-providers/_common/register/$llmToolsRegister';
88
93
  import { createLlmToolsFromConfiguration } from '../llm-providers/_common/register/createLlmToolsFromConfiguration';
89
94
  import { cacheLlmTools } from '../llm-providers/_common/utils/cache/cacheLlmTools';
90
- import { countTotalUsage } from '../llm-providers/_common/utils/count-total-usage/countTotalUsage';
95
+ import { countUsage } from '../llm-providers/_common/utils/count-total-usage/countUsage';
91
96
  import { limitTotalUsage } from '../llm-providers/_common/utils/count-total-usage/limitTotalUsage';
92
97
  import { _AnthropicClaudeMetadataRegistration } from '../llm-providers/anthropic-claude/register-configuration';
93
98
  import { _AzureOpenAiMetadataRegistration } from '../llm-providers/azure-openai/register-configuration';
@@ -115,6 +120,7 @@ import { prepareKnowledgePieces } from '../scrapers/_common/prepareKnowledgePiec
115
120
  import { $scrapersMetadataRegister } from '../scrapers/_common/register/$scrapersMetadataRegister';
116
121
  import { $scrapersRegister } from '../scrapers/_common/register/$scrapersRegister';
117
122
  import { makeKnowledgeSourceHandler } from '../scrapers/_common/utils/makeKnowledgeSourceHandler';
123
+ import { promptbookFetch } from '../scrapers/_common/utils/promptbookFetch';
118
124
  import { _LegacyDocumentScraperMetadataRegistration } from '../scrapers/document-legacy/register-metadata';
119
125
  import { _DocumentScraperMetadataRegistration } from '../scrapers/document/register-metadata';
120
126
  import { _MarkdownScraperMetadataRegistration } from '../scrapers/markdown/register-metadata';
@@ -155,9 +161,10 @@ export { DEFAULT_BOOKS_DIRNAME };
155
161
  export { DEFAULT_DOWNLOAD_CACHE_DIRNAME };
156
162
  export { DEFAULT_EXECUTION_CACHE_DIRNAME };
157
163
  export { DEFAULT_SCRAPE_CACHE_DIRNAME };
164
+ export { CLI_APP_ID };
165
+ export { PLAYGROUND_APP_ID };
158
166
  export { DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME };
159
- export { DEFAULT_REMOTE_URL };
160
- export { DEFAULT_REMOTE_URL_PATH };
167
+ export { DEFAULT_REMOTE_SERVER_URL };
161
168
  export { DEFAULT_CSV_SETTINGS };
162
169
  export { DEFAULT_IS_VERBOSE };
163
170
  export { SET_IS_VERBOSE };
@@ -176,6 +183,7 @@ export type { CallbackInterfaceToolsOptions };
176
183
  export { BoilerplateError };
177
184
  export { PROMPTBOOK_ERRORS };
178
185
  export { AbstractFormatError };
186
+ export { AuthenticationError };
179
187
  export { CollectionError };
180
188
  export { EnvironmentMismatchError };
181
189
  export { ExpectError };
@@ -188,6 +196,7 @@ export { ParseError };
188
196
  export { PipelineExecutionError };
189
197
  export { PipelineLogicError };
190
198
  export { PipelineUrlError };
199
+ export { PromptbookFetchError };
191
200
  export { UnexpectedError };
192
201
  export { createPipelineExecutor };
193
202
  export { embeddingVectorToString };
@@ -196,6 +205,8 @@ export type { ExecutionReportStringOptions };
196
205
  export { ExecutionReportStringOptionsDefaults };
197
206
  export { addUsage };
198
207
  export { isPassingExpectations };
208
+ export { ZERO_VALUE };
209
+ export { UNCERTAIN_ZERO_VALUE };
199
210
  export { ZERO_USAGE };
200
211
  export { UNCERTAIN_USAGE };
201
212
  export { usageToHuman };
@@ -217,7 +228,7 @@ export { $llmToolsMetadataRegister };
217
228
  export { $llmToolsRegister };
218
229
  export { createLlmToolsFromConfiguration };
219
230
  export { cacheLlmTools };
220
- export { countTotalUsage };
231
+ export { countUsage };
221
232
  export { limitTotalUsage };
222
233
  export { _AnthropicClaudeMetadataRegistration };
223
234
  export { _AzureOpenAiMetadataRegistration };
@@ -245,6 +256,7 @@ export { prepareKnowledgePieces };
245
256
  export { $scrapersMetadataRegister };
246
257
  export { $scrapersRegister };
247
258
  export { makeKnowledgeSourceHandler };
259
+ export { promptbookFetch };
248
260
  export { _LegacyDocumentScraperMetadataRegistration };
249
261
  export { _DocumentScraperMetadataRegistration };
250
262
  export { _MarkdownScraperMetadataRegistration };
@@ -2,17 +2,15 @@ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import { compilePipelineOnRemoteServer } from '../conversion/compilePipelineOnRemoteServer';
3
3
  import { RemoteLlmExecutionTools } from '../llm-providers/remote/RemoteLlmExecutionTools';
4
4
  import { preparePipelineOnRemoteServer } from '../prepare/preparePipelineOnRemoteServer';
5
- import type { PromptbookServer_Identification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
6
- import type { PromptbookServer_ApplicationIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
7
- import type { PromptbookServer_AnonymousIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
5
+ import type { Identification } from '../remote-server/socket-types/_subtypes/Identification';
6
+ import type { ApplicationModeIdentification } from '../remote-server/socket-types/_subtypes/Identification';
7
+ import type { AnonymousModeIdentification } from '../remote-server/socket-types/_subtypes/Identification';
8
8
  import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOptions';
9
- import type { RemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
10
9
  export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
11
10
  export { compilePipelineOnRemoteServer };
12
11
  export { RemoteLlmExecutionTools };
13
12
  export { preparePipelineOnRemoteServer };
14
- export type { PromptbookServer_Identification };
15
- export type { PromptbookServer_ApplicationIdentification };
16
- export type { PromptbookServer_AnonymousIdentification };
13
+ export type { Identification };
14
+ export type { ApplicationModeIdentification };
15
+ export type { AnonymousModeIdentification };
17
16
  export type { RemoteClientOptions };
18
- export type { RemoteServerOptions };
@@ -1,12 +1,12 @@
1
1
  import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
- import type { PromptbookServer_Identification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
3
- import type { PromptbookServer_ApplicationIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
4
- import type { PromptbookServer_AnonymousIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
2
+ import type { Identification } from '../remote-server/socket-types/_subtypes/Identification';
3
+ import type { ApplicationModeIdentification } from '../remote-server/socket-types/_subtypes/Identification';
4
+ import type { AnonymousModeIdentification } from '../remote-server/socket-types/_subtypes/Identification';
5
5
  import { startRemoteServer } from '../remote-server/startRemoteServer';
6
6
  import type { RemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
7
7
  export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
8
- export type { PromptbookServer_Identification };
9
- export type { PromptbookServer_ApplicationIdentification };
10
- export type { PromptbookServer_AnonymousIdentification };
8
+ export type { Identification };
9
+ export type { ApplicationModeIdentification };
10
+ export type { AnonymousModeIdentification };
11
11
  export { startRemoteServer };
12
12
  export type { RemoteServerOptions };
@@ -54,11 +54,11 @@ import type { PromptResult } from '../execution/PromptResult';
54
54
  import type { CompletionPromptResult } from '../execution/PromptResult';
55
55
  import type { ChatPromptResult } from '../execution/PromptResult';
56
56
  import type { EmbeddingPromptResult } from '../execution/PromptResult';
57
- import type { PromptResultUsage } from '../execution/PromptResultUsage';
58
- import type { PromptResultUsageCounts } from '../execution/PromptResultUsage';
59
57
  import type { ScriptExecutionTools } from '../execution/ScriptExecutionTools';
60
58
  import type { ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
61
59
  import type { UncertainNumber } from '../execution/UncertainNumber';
60
+ import type { Usage } from '../execution/Usage';
61
+ import type { UsageCounts } from '../execution/Usage';
62
62
  import type { UserInterfaceTools } from '../execution/UserInterfaceTools';
63
63
  import type { UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
64
64
  import type { FormatSubvalueDefinition } from '../formats/_common/FormatSubvalueDefinition';
@@ -107,14 +107,17 @@ import type { SimpleTaskJson } from '../pipeline/PipelineJson/SimpleTaskJson';
107
107
  import type { TaskJson } from '../pipeline/PipelineJson/TaskJson';
108
108
  import type { PipelineString } from '../pipeline/PipelineString';
109
109
  import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
110
- import type { PromptbookServer_Identification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
111
- import type { PromptbookServer_ApplicationIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
112
- import type { PromptbookServer_AnonymousIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
110
+ import type { RemoteServer } from '../remote-server/RemoteServer';
111
+ import type { Identification } from '../remote-server/socket-types/_subtypes/Identification';
112
+ import type { ApplicationModeIdentification } from '../remote-server/socket-types/_subtypes/Identification';
113
+ import type { AnonymousModeIdentification } from '../remote-server/socket-types/_subtypes/Identification';
113
114
  import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOptions';
114
115
  import type { RemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
115
116
  import type { AnonymousRemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
116
117
  import type { ApplicationRemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
117
118
  import type { ApplicationRemoteServerClientOptions } from '../remote-server/types/RemoteServerOptions';
119
+ import type { LoginRequest } from '../remote-server/types/RemoteServerOptions';
120
+ import type { LoginResponse } from '../remote-server/types/RemoteServerOptions';
118
121
  import type { Converter } from '../scrapers/_common/Converter';
119
122
  import type { ScraperAndConverterMetadata } from '../scrapers/_common/register/ScraperAndConverterMetadata';
120
123
  import type { ScraperConstructor } from '../scrapers/_common/register/ScraperConstructor';
@@ -174,6 +177,7 @@ import type { string_markdown_text } from '../types/typeAliases';
174
177
  import type { string_markdown_codeblock_language } from '../types/typeAliases';
175
178
  import type { string_promptbook_documentation_url } from '../types/typeAliases';
176
179
  import type { string_domain } from '../types/typeAliases';
180
+ import type { string_origin } from '../types/typeAliases';
177
181
  import type { string_tdl } from '../types/typeAliases';
178
182
  import type { string_css } from '../types/typeAliases';
179
183
  import type { string_svg } from '../types/typeAliases';
@@ -337,11 +341,11 @@ export type { PromptResult };
337
341
  export type { CompletionPromptResult };
338
342
  export type { ChatPromptResult };
339
343
  export type { EmbeddingPromptResult };
340
- export type { PromptResultUsage };
341
- export type { PromptResultUsageCounts };
342
344
  export type { ScriptExecutionTools };
343
345
  export type { ScriptExecutionToolsExecuteOptions };
344
346
  export type { UncertainNumber };
347
+ export type { Usage };
348
+ export type { UsageCounts };
345
349
  export type { UserInterfaceTools };
346
350
  export type { UserInterfaceToolsPromptDialogOptions };
347
351
  export type { FormatSubvalueDefinition };
@@ -390,14 +394,17 @@ export type { SimpleTaskJson };
390
394
  export type { TaskJson };
391
395
  export type { PipelineString };
392
396
  export type { PrepareAndScrapeOptions };
393
- export type { PromptbookServer_Identification };
394
- export type { PromptbookServer_ApplicationIdentification };
395
- export type { PromptbookServer_AnonymousIdentification };
397
+ export type { RemoteServer };
398
+ export type { Identification };
399
+ export type { ApplicationModeIdentification };
400
+ export type { AnonymousModeIdentification };
396
401
  export type { RemoteClientOptions };
397
402
  export type { RemoteServerOptions };
398
403
  export type { AnonymousRemoteServerOptions };
399
404
  export type { ApplicationRemoteServerOptions };
400
405
  export type { ApplicationRemoteServerClientOptions };
406
+ export type { LoginRequest };
407
+ export type { LoginResponse };
401
408
  export type { Converter };
402
409
  export type { ScraperAndConverterMetadata };
403
410
  export type { ScraperConstructor };
@@ -457,6 +464,7 @@ export type { string_markdown_text };
457
464
  export type { string_markdown_codeblock_language };
458
465
  export type { string_promptbook_documentation_url };
459
466
  export type { string_domain };
467
+ export type { string_origin };
460
468
  export type { string_tdl };
461
469
  export type { string_css };
462
470
  export type { string_svg };
@@ -0,0 +1,15 @@
1
+ import type { Command as Program } from 'commander';
2
+ /**
3
+ * Initializes `login` command for Promptbook CLI utilities
4
+ *
5
+ * Note: `$` is used to indicate that this function is not a pure function - it registers a command in the CLI
6
+ *
7
+ * @private internal function of `promptbookCli`
8
+ */
9
+ export declare function $initializeLoginCommand(program: Program): void;
10
+ /**
11
+ * TODO: Pass remote server URL (and path)
12
+ * TODO: Implement non-interactive login
13
+ * Note: [💞] Ignore a discrepancy between file name and entity name
14
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
15
+ */
@@ -0,0 +1,7 @@
1
+ import { Command } from 'commander';
2
+ /**
3
+ * Note: `$` is used to indicate that this function is not a pure function - it registers an option in the CLI
4
+ *
5
+ * @private utility of CLI
6
+ */
7
+ export declare function $addGlobalOptionsToCommand(command: Command): void;
@@ -0,0 +1,15 @@
1
+ import type { CacheLlmToolsOptions } from '../../llm-providers/_common/utils/cache/CacheLlmToolsOptions';
2
+ import type { string_url } from '../../types/typeAliases';
3
+ type ProvideLlmToolsForCliOptions = Pick<CacheLlmToolsOptions, 'isCacheReloaded'> & {
4
+ cliOptions: {
5
+ verbose: boolean;
6
+ interactive: boolean;
7
+ provider: 'BYOK' | 'BRING_YOUR_OWN_KEYS' | 'REMOTE_SERVER' | 'RS' | string;
8
+ remoteServerUrl: string_url;
9
+ };
10
+ };
11
+ /**
12
+ * @private utility of CLI
13
+ */
14
+ export declare function $provideLlmToolsForCli(options: ProvideLlmToolsForCliOptions): Promise<import("../../_packages/types.index").LlmExecutionToolsWithTotalUsage>;
15
+ export {};
@@ -1,5 +1,6 @@
1
1
  import type { CsvSettings } from './formats/csv/CsvSettings';
2
2
  import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
3
+ import type { string_app_id } from './types/typeAliases';
3
4
  import type { string_email } from './types/typeAliases';
4
5
  import type { string_name } from './types/typeAliases';
5
6
  import type { string_url_image } from './types/typeAliases';
@@ -208,6 +209,18 @@ export declare const DEFAULT_EXECUTION_CACHE_DIRNAME = "./.promptbook/execution-
208
209
  * @public exported from `@promptbook/core`
209
210
  */
210
211
  export declare const DEFAULT_SCRAPE_CACHE_DIRNAME = "./.promptbook/scrape-cache";
212
+ /**
213
+ * Id of application for the CLI when using remote server
214
+ *
215
+ * @public exported from `@promptbook/core`
216
+ */
217
+ export declare const CLI_APP_ID: string_app_id;
218
+ /**
219
+ * Id of application for the playground
220
+ *
221
+ * @public exported from `@promptbook/core`
222
+ */
223
+ export declare const PLAYGROUND_APP_ID: string_app_id;
211
224
  /**
212
225
  * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
213
226
  *
@@ -228,13 +241,7 @@ export declare const MOMENT_ARG_THRESHOLDS: {
228
241
  *
229
242
  * @public exported from `@promptbook/core`
230
243
  */
231
- export declare const DEFAULT_REMOTE_URL = "https://api.pavolhejny.com/";
232
- /**
233
- * @@@
234
- *
235
- * @public exported from `@promptbook/core`
236
- */
237
- export declare const DEFAULT_REMOTE_URL_PATH = "/promptbook/socket.io";
244
+ export declare const DEFAULT_REMOTE_SERVER_URL = "https://api.pavolhejny.com/promptbook";
238
245
  /**
239
246
  * @@@
240
247
  *
@@ -281,5 +288,5 @@ export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
281
288
  export declare const IS_COST_PREVENTED: boolean;
282
289
  /**
283
290
  * Note: [💞] Ignore a discrepancy between file name and entity name
284
- * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
291
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteServerUrl and path into single value
285
292
  */
@@ -1,5 +1,6 @@
1
1
  import { CsvFormatError } from '../formats/csv/CsvFormatError';
2
2
  import { AbstractFormatError } from './AbstractFormatError';
3
+ import { AuthenticationError } from './AuthenticationError';
3
4
  import { CollectionError } from './CollectionError';
4
5
  import { EnvironmentMismatchError } from './EnvironmentMismatchError';
5
6
  import { ExpectError } from './ExpectError';
@@ -12,6 +13,7 @@ import { ParseError } from './ParseError';
12
13
  import { PipelineExecutionError } from './PipelineExecutionError';
13
14
  import { PipelineLogicError } from './PipelineLogicError';
14
15
  import { PipelineUrlError } from './PipelineUrlError';
16
+ import { PromptbookFetchError } from './PromptbookFetchError';
15
17
  import { UnexpectedError } from './UnexpectedError';
16
18
  /**
17
19
  * Index of all custom errors
@@ -49,6 +51,8 @@ export declare const COMMON_JAVASCRIPT_ERRORS: {
49
51
  readonly TypeError: TypeErrorConstructor;
50
52
  readonly URIError: URIErrorConstructor;
51
53
  readonly AggregateError: AggregateErrorConstructor;
54
+ readonly AuthenticationError: typeof AuthenticationError;
55
+ readonly PromptbookFetchError: typeof PromptbookFetchError;
52
56
  };
53
57
  /**
54
58
  * Index of all errors
@@ -64,6 +68,8 @@ export declare const ALL_ERRORS: {
64
68
  readonly TypeError: TypeErrorConstructor;
65
69
  readonly URIError: URIErrorConstructor;
66
70
  readonly AggregateError: AggregateErrorConstructor;
71
+ readonly AuthenticationError: typeof AuthenticationError;
72
+ readonly PromptbookFetchError: typeof PromptbookFetchError;
67
73
  readonly AbstractFormatError: typeof AbstractFormatError;
68
74
  readonly CsvFormatError: typeof CsvFormatError;
69
75
  readonly CollectionError: typeof CollectionError;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * AuthenticationError is thrown from login function which is dependency of remote server
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class AuthenticationError extends Error {
7
+ readonly name = "AuthenticationError";
8
+ constructor(message: string);
9
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Error thrown when a fetch request fails
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class PromptbookFetchError extends Error {
7
+ readonly name = "PromptbookFetchError";
8
+ constructor(message: string);
9
+ }
@@ -3,7 +3,7 @@ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
3
3
  import type { Parameters } from '../types/typeAliases';
4
4
  import type { AbstractTaskResult } from './AbstractTaskResult';
5
5
  import type { ExecutionReportJson } from './execution-report/ExecutionReportJson';
6
- import type { PromptResultUsage } from './PromptResultUsage';
6
+ import type { Usage } from './Usage';
7
7
  /**
8
8
  * @@@
9
9
  *
@@ -19,7 +19,7 @@ export type PipelineExecutorResult = AbstractTaskResult & {
19
19
  /**
20
20
  * Added usage of whole execution, detailed usage is available in `executionReport`
21
21
  */
22
- readonly usage: ReadonlyDeep<PromptResultUsage>;
22
+ readonly usage: ReadonlyDeep<Usage>;
23
23
  /**
24
24
  * The report of the execution with all details
25
25
  */
@@ -3,7 +3,7 @@ import type { string_model_name } from '../types/typeAliases';
3
3
  import type { string_prompt } from '../types/typeAliases';
4
4
  import type { TODO_object } from '../utils/organization/TODO_object';
5
5
  import type { EmbeddingVector } from './EmbeddingVector';
6
- import type { PromptResultUsage } from './PromptResultUsage';
6
+ import type { Usage } from './Usage';
7
7
  /**
8
8
  * Prompt result is the simplest concept of execution.
9
9
  * It is the result of executing one prompt _(NOT a template)_.
@@ -71,7 +71,7 @@ export type CommonPromptResult = {
71
71
  /**
72
72
  * Usage of the prompt execution
73
73
  */
74
- readonly usage: PromptResultUsage;
74
+ readonly usage: Usage;
75
75
  /**
76
76
  * Exact text of the prompt (with all replacements)
77
77
  *
@@ -2,11 +2,11 @@ import type { KebabCase } from 'type-fest';
2
2
  import type { ExpectationUnit } from '../pipeline/PipelineJson/Expectations';
3
3
  import type { UncertainNumber } from './UncertainNumber';
4
4
  /**
5
- * Usage statistics for one or many prompt results
5
+ * Usage statistics for one or more prompt results
6
6
  *
7
7
  * Note: [🚉] This is fully serializable as JSON
8
8
  */
9
- export type PromptResultUsage = {
9
+ export type Usage = {
10
10
  /**
11
11
  * Cost of the execution in USD
12
12
  *
@@ -16,18 +16,18 @@ export type PromptResultUsage = {
16
16
  /**
17
17
  * Number of whatever used in the input aka. `prompt_tokens`
18
18
  */
19
- readonly input: PromptResultUsageCounts;
19
+ readonly input: UsageCounts;
20
20
  /**
21
21
  * Number of tokens used in the output aka. `completion_tokens`
22
22
  */
23
- readonly output: PromptResultUsageCounts;
23
+ readonly output: UsageCounts;
24
24
  };
25
25
  /**
26
26
  * Record of all possible measurable units
27
27
  *
28
28
  * Note: [🚉] This is fully serializable as JSON
29
29
  */
30
- export type PromptResultUsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
30
+ export type UsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
31
31
  /**
32
32
  * TODO: [🍙] Make some standard order of json properties
33
33
  */
@@ -1,4 +1,4 @@
1
- import type { PromptResultUsage } from '../PromptResultUsage';
1
+ import type { Usage } from '../Usage';
2
2
  /**
3
3
  * Function `addUsage` will add multiple usages into one
4
4
  *
@@ -6,4 +6,4 @@ import type { PromptResultUsage } from '../PromptResultUsage';
6
6
  *
7
7
  * @public exported from `@promptbook/core`
8
8
  */
9
- export declare function addUsage(...usageItems: ReadonlyArray<PromptResultUsage>): PromptResultUsage;
9
+ export declare function addUsage(...usageItems: ReadonlyArray<Usage>): Usage;
@@ -1,10 +1,10 @@
1
- import type { PromptResultUsageCounts } from '../PromptResultUsage';
1
+ import type { UsageCounts } from '../Usage';
2
2
  /**
3
3
  * Helper of usage compute
4
4
  *
5
5
  * @param content the content of prompt or response
6
- * @returns part of PromptResultUsageCounts
6
+ * @returns part of UsageCounts
7
7
  *
8
8
  * @private internal utility of LlmExecutionTools
9
9
  */
10
- export declare function computeUsageCounts(content: string): Omit<PromptResultUsageCounts, 'tokensCount'>;
10
+ export declare function computeUsageCounts(content: string): Omit<UsageCounts, 'tokensCount'>;