@promptbook/documents 0.89.0-3 → 0.89.0-30

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 (50) hide show
  1. package/README.md +9 -7
  2. package/esm/index.es.js +122 -39
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/servers.d.ts +40 -0
  5. package/esm/typings/src/_packages/core.index.d.ts +20 -8
  6. package/esm/typings/src/_packages/remote-client.index.d.ts +6 -8
  7. package/esm/typings/src/_packages/remote-server.index.d.ts +6 -6
  8. package/esm/typings/src/_packages/types.index.d.ts +24 -12
  9. package/esm/typings/src/cli/cli-commands/login.d.ts +0 -1
  10. package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +7 -0
  11. package/esm/typings/src/cli/common/$provideLlmToolsForCli.d.ts +28 -0
  12. package/esm/typings/src/cli/test/ptbk.d.ts +1 -1
  13. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +2 -0
  14. package/esm/typings/src/config.d.ts +24 -26
  15. package/esm/typings/src/errors/0-index.d.ts +9 -0
  16. package/esm/typings/src/errors/AuthenticationError.d.ts +9 -0
  17. package/esm/typings/src/errors/PipelineExecutionError.d.ts +1 -1
  18. package/esm/typings/src/errors/PromptbookFetchError.d.ts +9 -0
  19. package/esm/typings/src/errors/WrappedError.d.ts +10 -0
  20. package/esm/typings/src/errors/assertsError.d.ts +11 -0
  21. package/esm/typings/src/execution/PromptbookFetch.d.ts +1 -1
  22. package/esm/typings/src/llm-providers/_common/register/$provideEnvFilename.d.ts +12 -0
  23. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +2 -8
  24. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +2 -0
  25. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizzardOrCli.d.ts +45 -1
  26. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +1 -0
  27. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +1 -1
  28. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +1 -1
  29. package/esm/typings/src/remote-server/RemoteServer.d.ts +23 -0
  30. package/esm/typings/src/remote-server/openapi-types.d.ts +284 -0
  31. package/esm/typings/src/remote-server/openapi.d.ts +187 -0
  32. package/esm/typings/src/remote-server/socket-types/_subtypes/{PromptbookServer_Identification.d.ts → Identification.d.ts} +3 -3
  33. package/esm/typings/src/remote-server/socket-types/_subtypes/identificationToPromptbookToken.d.ts +11 -0
  34. package/esm/typings/src/remote-server/socket-types/_subtypes/promptbookTokenToIdentification.d.ts +10 -0
  35. package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts +2 -2
  36. package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Request.d.ts +2 -2
  37. package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Request.d.ts +2 -2
  38. package/esm/typings/src/remote-server/startRemoteServer.d.ts +3 -4
  39. package/esm/typings/src/remote-server/types/RemoteClientOptions.d.ts +4 -12
  40. package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts +84 -9
  41. package/esm/typings/src/scrapers/_common/utils/{scraperFetch.d.ts → promptbookFetch.d.ts} +2 -2
  42. package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +40 -0
  43. package/esm/typings/src/types/typeAliases.d.ts +19 -0
  44. package/esm/typings/src/utils/organization/TODO_narrow.d.ts +6 -0
  45. package/package.json +8 -4
  46. package/umd/index.umd.js +122 -39
  47. package/umd/index.umd.js.map +1 -1
  48. package/esm/typings/src/cli/test/ptbk2.d.ts +0 -5
  49. package/esm/typings/src/playground/BrjappConnector.d.ts +0 -67
  50. package/esm/typings/src/playground/brjapp-api-schema.d.ts +0 -12879
@@ -1,4 +1,4 @@
1
- import type { IDestroyable } from 'destroyable';
1
+ import type { RemoteServer } from './RemoteServer';
2
2
  import type { RemoteServerOptions } from './types/RemoteServerOptions';
3
3
  /**
4
4
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
@@ -9,10 +9,9 @@ import type { RemoteServerOptions } from './types/RemoteServerOptions';
9
9
  * @see https://github.com/webgptorg/promptbook#remote-server
10
10
  * @public exported from `@promptbook/remote-server`
11
11
  */
12
- export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): IDestroyable;
12
+ export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): RemoteServer;
13
13
  /**
14
- * TODO: !! Add CORS and security - probbably via `helmet`
15
- * TODO: [👩🏾‍🤝‍🧑🏾] Allow to pass custom fetch function here - PromptbookFetch
14
+ * TODO: [🌡] Add CORS and security - probbably via `helmet`
16
15
  * TODO: Split this file into multiple functions - handler for each request
17
16
  * TODO: Maybe use `$exportJson`
18
17
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
@@ -1,7 +1,6 @@
1
1
  import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
2
2
  import type { string_base_url } from '../../types/typeAliases';
3
- import type { string_uri } from '../../types/typeAliases';
4
- import type { PromptbookServer_Identification } from '../socket-types/_subtypes/PromptbookServer_Identification';
3
+ import type { Identification } from '../socket-types/_subtypes/Identification';
5
4
  /**
6
5
  * Options for `RemoteLlmExecutionTools`
7
6
  *
@@ -12,21 +11,14 @@ export type RemoteClientOptions<TCustomOptions> = CommonToolsOptions & {
12
11
  * URL of the remote server
13
12
  * On this server will be connected to the socket.io server
14
13
  */
15
- readonly remoteUrl: string_base_url;
16
- /**
17
- * Path for the Socket.io server to listen
18
- *
19
- * @default '/socket.io'
20
- * @example '/promptbook/socket.io'
21
- */
22
- readonly path: string_uri;
14
+ readonly remoteServerUrl: string_base_url;
23
15
  /**
24
16
  * Identification of client for Socket.io remote server
25
17
  */
26
- readonly identification: PromptbookServer_Identification<TCustomOptions>;
18
+ readonly identification: Identification<TCustomOptions>;
27
19
  };
28
20
  /**
29
21
  * TODO: Pass more options from Socket.io to `RemoteClientOptions` (like `transports`)
30
22
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
31
- * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
23
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteServerUrl and path into single value
32
24
  */
@@ -1,10 +1,16 @@
1
+ import type { Request, Response } from 'express';
1
2
  import type { Promisable } from 'type-fest';
2
3
  import type { PipelineCollection } from '../../collection/PipelineCollection';
4
+ import { AuthenticationError } from '../../errors/AuthenticationError';
3
5
  import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
6
+ import type { ExecutionTools } from '../../execution/ExecutionTools';
4
7
  import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
5
8
  import type { string_app_id } from '../../types/typeAliases';
6
- import type { string_uri } from '../../types/typeAliases';
9
+ import type { string_email } from '../../types/typeAliases';
10
+ import type { string_password } from '../../types/typeAliases';
7
11
  import type { string_user_id } from '../../types/typeAliases';
12
+ import type { ApplicationModeIdentification } from '../socket-types/_subtypes/Identification';
13
+ import type { Identification } from '../socket-types/_subtypes/Identification';
8
14
  /**
9
15
  * @@@
10
16
  *
@@ -16,7 +22,6 @@ import type { string_user_id } from '../../types/typeAliases';
16
22
  *
17
23
  * You can enable both modes at the same time.
18
24
  *
19
- * @public exported from `@promptbook/remote-client`
20
25
  * @public exported from `@promptbook/remote-server`
21
26
  */
22
27
  export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
@@ -25,15 +30,23 @@ export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
25
30
  */
26
31
  readonly port: number;
27
32
  /**
28
- * Root path of the server
33
+ * Creates execution tools the client
29
34
  *
30
- * Note: This is useful when you reverse proxy the server without changing the path
35
+ * This is relevant also in anonymous mode in oposition to `createLlmExecutionTools`
31
36
  *
32
- * @default '/'
33
- * @example '/api/promptbook/'
37
+ * Note: You can provide only some tools and leave the rest to the default ones also llm tools are created by `createLlmExecutionTools`
38
+ * Note: This is useful when you want to provide some custom restrictions for example:
39
+ * - Limit access to certain websites for some users
40
+ * - Bind user-interface tools to email agent
41
+ * - Allow / block script execution
42
+ * - And many more
34
43
  */
35
- readonly rootPath: string_uri;
36
- } & (AnonymousRemoteServerOptions | ApplicationRemoteServerOptions<TCustomOptions> | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
44
+ createExecutionTools?(options: Identification<TCustomOptions>): Promisable<Partial<Omit<ExecutionTools, 'llm'>>>;
45
+ } & ((AnonymousRemoteServerOptions & {
46
+ readonly isApplicationModeAllowed?: false;
47
+ }) | ({
48
+ readonly isAnonymousModeAllowed?: false;
49
+ } & ApplicationRemoteServerOptions<TCustomOptions>) | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
37
50
  export type AnonymousRemoteServerOptions = {
38
51
  /**
39
52
  * Enable anonymous mode
@@ -51,10 +64,22 @@ export type ApplicationRemoteServerOptions<TCustomOptions> = {
51
64
  * This is used to check validity of the prompt to prevent misuse
52
65
  */
53
66
  readonly collection: PipelineCollection;
67
+ /**
68
+ * User tries to login to the server, this function will be called verify the user and return the identification or throw an error
69
+ * This can be also doubled as a function to register the user
70
+ *
71
+ * Note: In most cases, you will return `PromptbookServer_ApplicationIdentification`
72
+ * `PromptbookServer_AnonymousIdentification` is useful only in scenarios when user stores its own api keys on the application server and
73
+ * server acts only as a api key provider
74
+ *
75
+ * Note: In most cases DO NOT THROW `AuthenticationError` but return `isSuccess: false` with message
76
+ * @throws `AuthenticationError` if the user is not allowed to login for example because of invalid credentials
77
+ */
78
+ login(loginRequest: LoginRequest): Promise<LoginResponse<TCustomOptions>>;
54
79
  /**
55
80
  * Creates llm execution tools for each client
56
81
  */
57
- createLlmExecutionTools(options: ApplicationRemoteServerClientOptions<TCustomOptions>): Promisable<LlmExecutionTools>;
82
+ createLlmExecutionTools(options: ApplicationModeIdentification<TCustomOptions>): Promisable<LlmExecutionTools>;
58
83
  };
59
84
  export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
60
85
  /**
@@ -82,6 +107,56 @@ export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
82
107
  */
83
108
  readonly customOptions?: TCustomOptions;
84
109
  };
110
+ /**
111
+ * Login request for the application mode
112
+ */
113
+ export type LoginRequest = {
114
+ /**
115
+ * Identifier of the application you are using
116
+ *
117
+ * Note: This is usefull when you use Promptbook remote server for multiple apps/frontends, if its used just for single app, use here just "app" or "your-app-name"
118
+ */
119
+ readonly appId: string_app_id | null;
120
+ /**
121
+ * Username (for example email) of the user
122
+ */
123
+ readonly username: string_email | string;
124
+ /**
125
+ * Password of the user
126
+ */
127
+ readonly password: string_password;
128
+ /**
129
+ * Request object from express if you want to access some request data for example headers, IP address, etc.
130
+ */
131
+ readonly rawRequest: Request;
132
+ /**
133
+ * Response object from express if you want to add some custom headers.
134
+ *
135
+ * Note: It is not recommended to use this object to send body of the response because it can confuse the client
136
+ */
137
+ readonly rawResponse: Response;
138
+ };
139
+ /**
140
+ * Login response for the application mode
141
+ */
142
+ export type LoginResponse<TCustomOptions> = {
143
+ /**
144
+ * Was the login successful
145
+ */
146
+ readonly isSuccess: boolean;
147
+ /**
148
+ * Message to display to the user, this message is always displayed
149
+ */
150
+ readonly message?: string;
151
+ /**
152
+ * Optional error if the login was not successful
153
+ */
154
+ readonly error?: AuthenticationError;
155
+ /**
156
+ * Identification of the user to be used in the future requests
157
+ */
158
+ readonly identification?: Identification<TCustomOptions>;
159
+ };
85
160
  /**
86
161
  * TODO: Constrain anonymous mode for specific models / providers
87
162
  */
@@ -2,9 +2,9 @@ import type { PromptbookFetch } from '../../../execution/PromptbookFetch';
2
2
  /**
3
3
  * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
4
4
  *
5
- * @private as default `fetch` function used in Promptbook scrapers
5
+ * @public exported from `@promptbook/core`
6
6
  */
7
- export declare const scraperFetch: PromptbookFetch;
7
+ export declare const promptbookFetch: PromptbookFetch;
8
8
  /**
9
9
  * TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
10
10
  */
@@ -0,0 +1,40 @@
1
+ import type { PromptbookStorage } from '../_common/PromptbookStorage';
2
+ /**
3
+ * Stores data in .env variables
4
+ *
5
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file and also writes to `process.env`
6
+ *
7
+ * @private within the repository - for CLI utils
8
+ */
9
+ export declare class $EnvStorage<TItem> implements PromptbookStorage<TItem> {
10
+ private envFilename;
11
+ private $provideOrCreateEnvFile;
12
+ private transformKey;
13
+ /**
14
+ * Returns the number of key/value pairs currently present in the list associated with the object.
15
+ */
16
+ get length(): number;
17
+ /**
18
+ * Empties the list associated with the object of all key/value pairs, if there are any.
19
+ */
20
+ clear(): void;
21
+ /**
22
+ * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
23
+ */
24
+ getItem(key: string): Promise<TItem | null>;
25
+ /**
26
+ * Returns the name of the nth key in the list, or null if n is greater than or equal to the number of key/value pairs in the object.
27
+ */
28
+ key(index: number): string | null;
29
+ /**
30
+ * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
31
+ */
32
+ setItem(key: string, value: TItem): Promise<void>;
33
+ /**
34
+ * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
35
+ */
36
+ removeItem(key: string): void;
37
+ }
38
+ /**
39
+ * TODO: Write file more securely - ensure that there can be no accidental overwriting of existing variables and other content
40
+ */
@@ -325,6 +325,12 @@ export type string_css_selector = string;
325
325
  * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"`
326
326
  */
327
327
  export type string_url = string;
328
+ /**
329
+ * Semantic helper
330
+ *
331
+ * For example `"https://s1.ptbk.io/promptbook"`
332
+ */
333
+ export type string_promptbook_server_url = string;
328
334
  /**
329
335
  * Semantic helper
330
336
  *
@@ -521,6 +527,13 @@ export type string_person_profile = string;
521
527
  * For example `"MIT"`
522
528
  */
523
529
  export type string_license = string;
530
+ /**
531
+ * Semantic helper
532
+ *
533
+ * For example `"Pavol Hejný <pavol@ptbk.io> (https://www.pavolhejny.com/)"`
534
+ * For example `"AI Web, LLC <legal@ptbk.io> (https://www.ptbk.io/)"`
535
+ */
536
+ export type string_legal_entity = string | string_person_profile | string_title;
524
537
  /**
525
538
  * Semantic helper for attributes
526
539
  *
@@ -570,6 +583,12 @@ export type string_postprocessing_function_name = string;
570
583
  export type id = string | number;
571
584
  export type task_id = string;
572
585
  export type string_token = string;
586
+ /**
587
+ * Semantic helper
588
+ *
589
+ * Made by `identificationToPromptbookToken` exported from `@promptbook/core`
590
+ */
591
+ export type string_promptbook_token = string_token;
573
592
  export type string_license_token = string_token;
574
593
  export type string_password = string;
575
594
  export type string_ssh_key = string;
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Organizational helper to better mark the place where the more specific type is missing
3
+ *
4
+ * @private within the repository
5
+ */
6
+ export type TODO_narrow<T> = T;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/documents",
3
- "version": "0.89.0-3",
3
+ "version": "0.89.0-30",
4
4
  "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -43,19 +43,23 @@
43
43
  "url": "https://github.com/webgptorg/promptbook/issues"
44
44
  },
45
45
  "homepage": "https://ptbk.io/",
46
+ "engines": {
47
+ "node": ">=16.0.0",
48
+ "npm": ">=8.0.0"
49
+ },
46
50
  "main": "./umd/index.umd.js",
47
51
  "module": "./esm/index.es.js",
48
52
  "typings": "./esm/typings/src/_packages/documents.index.d.ts",
49
53
  "peerDependencies": {
50
- "@promptbook/core": "0.89.0-3"
54
+ "@promptbook/core": "0.89.0-30"
51
55
  },
52
56
  "dependencies": {
53
57
  "colors": "1.4.0",
54
- "crypto": "^1.0.1",
58
+ "crypto": "1.0.1",
55
59
  "crypto-js": "4.2.0",
56
60
  "papaparse": "5.4.1",
57
61
  "prettier": "2.8.1",
58
- "rxjs": "^7.8.1",
62
+ "rxjs": "7.8.1",
59
63
  "spacetrim": "0.11.59",
60
64
  "waitasecond": "1.11.83"
61
65
  }
package/umd/index.umd.js CHANGED
@@ -26,7 +26,7 @@
26
26
  * @generated
27
27
  * @see https://github.com/webgptorg/promptbook
28
28
  */
29
- const PROMPTBOOK_ENGINE_VERSION = '0.89.0-3';
29
+ const PROMPTBOOK_ENGINE_VERSION = '0.89.0-30';
30
30
  /**
31
31
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
32
32
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -89,6 +89,7 @@
89
89
  * @public exported from `@promptbook/core`
90
90
  */
91
91
  const ADMIN_GITHUB_NAME = 'hejny';
92
+ // <- TODO: [🐊] Pick the best claim
92
93
  /**
93
94
  * When the title is not provided, the default title is used
94
95
  *
@@ -121,6 +122,7 @@
121
122
  infinity: '(infinity; ∞)',
122
123
  negativeInfinity: '(negative infinity; -∞)',
123
124
  unserializable: '(unserializable value)',
125
+ circular: '(circular JSON)',
124
126
  };
125
127
  /**
126
128
  * Small number limit
@@ -160,6 +162,7 @@
160
162
  */
161
163
  const DEFAULT_MAX_EXECUTION_ATTEMPTS = 10; // <- TODO: [🤹‍♂️]
162
164
  // <- TODO: [🕝] Make also `BOOKS_DIRNAME_ALTERNATIVES`
165
+ // TODO: Just `.promptbook` in config, hardcode subfolders like `download-cache` or `execution-cache`
163
166
  /**
164
167
  * Where to store the temporary downloads
165
168
  *
@@ -211,7 +214,7 @@
211
214
  true);
212
215
  /**
213
216
  * Note: [💞] Ignore a discrepancy between file name and entity name
214
- * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
217
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteServerUrl and path into single value
215
218
  */
216
219
 
217
220
  /**
@@ -1067,6 +1070,54 @@
1067
1070
  * TODO: Maybe split `ParseError` and `ApplyError`
1068
1071
  */
1069
1072
 
1073
+ /**
1074
+ * This error type indicates that somewhere in the code non-Error object was thrown and it was wrapped into the `WrappedError`
1075
+ *
1076
+ * @public exported from `@promptbook/core`
1077
+ */
1078
+ class WrappedError extends Error {
1079
+ constructor(whatWasThrown) {
1080
+ const tag = `[🤮]`;
1081
+ console.error(tag, whatWasThrown);
1082
+ super(spaceTrim.spaceTrim(`
1083
+ Non-Error object was thrown
1084
+
1085
+ Note: Look for ${tag} in the console for more details
1086
+ Please report issue on ${ADMIN_EMAIL}
1087
+ `));
1088
+ this.name = 'WrappedError';
1089
+ Object.setPrototypeOf(this, WrappedError.prototype);
1090
+ }
1091
+ }
1092
+
1093
+ /**
1094
+ * Helper used in catch blocks to assert that the error is an instance of `Error`
1095
+ *
1096
+ * @param whatWasThrown Any object that was thrown
1097
+ * @returns Nothing if the error is an instance of `Error`
1098
+ * @throws `WrappedError` or `UnexpectedError` if the error is not standard
1099
+ *
1100
+ * @private within the repository
1101
+ */
1102
+ function assertsError(whatWasThrown) {
1103
+ // Case 1: Handle error which was rethrown as `WrappedError`
1104
+ if (whatWasThrown instanceof WrappedError) {
1105
+ const wrappedError = whatWasThrown;
1106
+ throw wrappedError;
1107
+ }
1108
+ // Case 2: Handle unexpected errors
1109
+ if (whatWasThrown instanceof UnexpectedError) {
1110
+ const unexpectedError = whatWasThrown;
1111
+ throw unexpectedError;
1112
+ }
1113
+ // Case 3: Handle standard errors - keep them up to consumer
1114
+ if (whatWasThrown instanceof Error) {
1115
+ return;
1116
+ }
1117
+ // Case 4: Handle non-standard errors - wrap them into `WrappedError` and throw
1118
+ throw new WrappedError(whatWasThrown);
1119
+ }
1120
+
1070
1121
  /**
1071
1122
  * Function isValidJsonString will tell you if the string is valid JSON or not
1072
1123
  *
@@ -1078,9 +1129,7 @@
1078
1129
  return true;
1079
1130
  }
1080
1131
  catch (error) {
1081
- if (!(error instanceof Error)) {
1082
- throw error;
1083
- }
1132
+ assertsError(error);
1084
1133
  if (error.message.includes('Unexpected token')) {
1085
1134
  return false;
1086
1135
  }
@@ -1433,9 +1482,7 @@
1433
1482
  JSON.stringify(value); // <- TODO: [0]
1434
1483
  }
1435
1484
  catch (error) {
1436
- if (!(error instanceof Error)) {
1437
- throw error;
1438
- }
1485
+ assertsError(error);
1439
1486
  throw new UnexpectedError(spaceTrim__default["default"]((block) => `
1440
1487
  \`${name}\` is not serializable
1441
1488
 
@@ -2206,7 +2253,7 @@
2206
2253
  }
2207
2254
  }
2208
2255
  /**
2209
- * TODO: !!!!!! Add id to all errors
2256
+ * TODO: [🧠][🌂] Add id to all errors
2210
2257
  */
2211
2258
 
2212
2259
  /**
@@ -2306,6 +2353,19 @@
2306
2353
  }
2307
2354
  }
2308
2355
 
2356
+ /**
2357
+ * AuthenticationError is thrown from login function which is dependency of remote server
2358
+ *
2359
+ * @public exported from `@promptbook/core`
2360
+ */
2361
+ class AuthenticationError extends Error {
2362
+ constructor(message) {
2363
+ super(message);
2364
+ this.name = 'AuthenticationError';
2365
+ Object.setPrototypeOf(this, AuthenticationError.prototype);
2366
+ }
2367
+ }
2368
+
2309
2369
  /**
2310
2370
  * This error indicates that the pipeline collection cannot be propperly loaded
2311
2371
  *
@@ -2371,6 +2431,19 @@
2371
2431
  }
2372
2432
  }
2373
2433
 
2434
+ /**
2435
+ * Error thrown when a fetch request fails
2436
+ *
2437
+ * @public exported from `@promptbook/core`
2438
+ */
2439
+ class PromptbookFetchError extends Error {
2440
+ constructor(message) {
2441
+ super(message);
2442
+ this.name = 'PromptbookFetchError';
2443
+ Object.setPrototypeOf(this, PromptbookFetchError.prototype);
2444
+ }
2445
+ }
2446
+
2374
2447
  /**
2375
2448
  * Index of all custom errors
2376
2449
  *
@@ -2391,7 +2464,10 @@
2391
2464
  PipelineExecutionError,
2392
2465
  PipelineLogicError,
2393
2466
  PipelineUrlError,
2467
+ AuthenticationError,
2468
+ PromptbookFetchError,
2394
2469
  UnexpectedError,
2470
+ WrappedError,
2395
2471
  // TODO: [🪑]> VersionMismatchError,
2396
2472
  };
2397
2473
  /**
@@ -2530,8 +2606,8 @@
2530
2606
  updatedAt = new Date();
2531
2607
  errors.push(...executionResult.errors);
2532
2608
  warnings.push(...executionResult.warnings);
2533
- // <- TODO: !!! Only unique errors and warnings should be added (or filtered)
2534
- // TODO: [🧠] !!! errors, warning, isSuccessful are redundant both in `ExecutionTask` and `ExecutionTask.currentValue`
2609
+ // <- TODO: [🌂] Only unique errors and warnings should be added (or filtered)
2610
+ // TODO: [🧠] !! errors, warning, isSuccessful are redundant both in `ExecutionTask` and `ExecutionTask.currentValue`
2535
2611
  // Also maybe move `ExecutionTask.currentValue.usage` -> `ExecutionTask.usage`
2536
2612
  // And delete `ExecutionTask.currentValue.preparedPipeline`
2537
2613
  assertsTaskSuccessful(executionResult);
@@ -2541,6 +2617,7 @@
2541
2617
  partialResultSubject.next(executionResult);
2542
2618
  }
2543
2619
  catch (error) {
2620
+ assertsError(error);
2544
2621
  status = 'ERROR';
2545
2622
  errors.push(error);
2546
2623
  partialResultSubject.error(error);
@@ -2607,6 +2684,10 @@
2607
2684
 
2608
2685
  Cannot serialize error with name "${name}"
2609
2686
 
2687
+ Authors of Promptbook probably forgot to add this error into the list of errors:
2688
+ https://github.com/webgptorg/promptbook/blob/main/src/errors/0-index.ts
2689
+
2690
+
2610
2691
  ${block(stack || message)}
2611
2692
 
2612
2693
  `));
@@ -2928,14 +3009,15 @@
2928
3009
  }
2929
3010
  }
2930
3011
  catch (error) {
2931
- if (!(error instanceof Error) || error instanceof UnexpectedError) {
3012
+ assertsError(error);
3013
+ if (error instanceof UnexpectedError) {
2932
3014
  throw error;
2933
3015
  }
2934
3016
  errors.push({ llmExecutionTools, error });
2935
3017
  }
2936
3018
  }
2937
3019
  if (errors.length === 1) {
2938
- throw errors[0];
3020
+ throw errors[0].error;
2939
3021
  }
2940
3022
  else if (errors.length > 1) {
2941
3023
  throw new PipelineExecutionError(
@@ -3373,17 +3455,22 @@
3373
3455
  /**
3374
3456
  * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
3375
3457
  *
3376
- * @private as default `fetch` function used in Promptbook scrapers
3458
+ * @public exported from `@promptbook/core`
3377
3459
  */
3378
- const scraperFetch = async (url, init) => {
3460
+ const promptbookFetch = async (urlOrRequest, init) => {
3379
3461
  try {
3380
- return await fetch(url, init);
3462
+ return await fetch(urlOrRequest, init);
3381
3463
  }
3382
3464
  catch (error) {
3383
- if (!(error instanceof Error)) {
3384
- throw error;
3465
+ assertsError(error);
3466
+ let url;
3467
+ if (typeof urlOrRequest === 'string') {
3468
+ url = urlOrRequest;
3469
+ }
3470
+ else if (urlOrRequest instanceof Request) {
3471
+ url = urlOrRequest.url;
3385
3472
  }
3386
- throw new KnowledgeScrapeError(spaceTrim__default["default"]((block) => `
3473
+ throw new PromptbookFetchError(spaceTrim__default["default"]((block) => `
3387
3474
  Can not fetch "${url}"
3388
3475
 
3389
3476
  Fetch error:
@@ -3404,7 +3491,7 @@
3404
3491
  async function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
3405
3492
  // console.log('!! makeKnowledgeSourceHandler', knowledgeSource);
3406
3493
  var _a;
3407
- const { fetch = scraperFetch } = tools;
3494
+ const { fetch = promptbookFetch } = tools;
3408
3495
  const { knowledgeSourceContent } = knowledgeSource;
3409
3496
  let { name } = knowledgeSource;
3410
3497
  const { rootDirname = null,
@@ -3606,9 +3693,7 @@
3606
3693
  knowledgePreparedUnflatten[index] = pieces;
3607
3694
  }
3608
3695
  catch (error) {
3609
- if (!(error instanceof Error)) {
3610
- throw error;
3611
- }
3696
+ assertsError(error);
3612
3697
  console.warn(error);
3613
3698
  // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
3614
3699
  }
@@ -3900,13 +3985,19 @@
3900
3985
  return value.toISOString();
3901
3986
  }
3902
3987
  else {
3903
- return JSON.stringify(value);
3988
+ try {
3989
+ return JSON.stringify(value);
3990
+ }
3991
+ catch (error) {
3992
+ if (error instanceof TypeError && error.message.includes('circular structure')) {
3993
+ return VALUE_STRINGS.circular;
3994
+ }
3995
+ throw error;
3996
+ }
3904
3997
  }
3905
3998
  }
3906
3999
  catch (error) {
3907
- if (!(error instanceof Error)) {
3908
- throw error;
3909
- }
4000
+ assertsError(error);
3910
4001
  console.error(error);
3911
4002
  return VALUE_STRINGS.unserializable;
3912
4003
  }
@@ -3963,9 +4054,7 @@
3963
4054
  }
3964
4055
  }
3965
4056
  catch (error) {
3966
- if (!(error instanceof Error)) {
3967
- throw error;
3968
- }
4057
+ assertsError(error);
3969
4058
  throw new ParseError(spaceTrim.spaceTrim((block) => `
3970
4059
  Can not extract variables from the script
3971
4060
  ${block(error.stack || error.message)}
@@ -4830,9 +4919,7 @@
4830
4919
  break scripts;
4831
4920
  }
4832
4921
  catch (error) {
4833
- if (!(error instanceof Error)) {
4834
- throw error;
4835
- }
4922
+ assertsError(error);
4836
4923
  if (error instanceof UnexpectedError) {
4837
4924
  throw error;
4838
4925
  }
@@ -4902,9 +4989,7 @@
4902
4989
  break scripts;
4903
4990
  }
4904
4991
  catch (error) {
4905
- if (!(error instanceof Error)) {
4906
- throw error;
4907
- }
4992
+ assertsError(error);
4908
4993
  if (error instanceof UnexpectedError) {
4909
4994
  throw error;
4910
4995
  }
@@ -5525,9 +5610,7 @@
5525
5610
  await Promise.all(resolving);
5526
5611
  }
5527
5612
  catch (error /* <- Note: [3] */) {
5528
- if (!(error instanceof Error)) {
5529
- throw error;
5530
- }
5613
+ assertsError(error);
5531
5614
  // Note: No need to rethrow UnexpectedError
5532
5615
  // if (error instanceof UnexpectedError) {
5533
5616
  // Note: Count usage, [🧠] Maybe put to separate function executionReportJsonToUsage + DRY [🤹‍♂️]