@promptbook/pdf 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 +9 -5
  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/pdf",
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/pdf.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
- "crypto": "^1.0.1",
57
+ "crypto": "1.0.1",
54
58
  "crypto-js": "4.2.0",
55
- "markitdown-ts": "^0.0.4",
59
+ "markitdown-ts": "0.0.4",
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
@@ -25,7 +25,7 @@
25
25
  * @generated
26
26
  * @see https://github.com/webgptorg/promptbook
27
27
  */
28
- const PROMPTBOOK_ENGINE_VERSION = '0.89.0-3';
28
+ const PROMPTBOOK_ENGINE_VERSION = '0.89.0-30';
29
29
  /**
30
30
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
31
31
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -88,6 +88,7 @@
88
88
  * @public exported from `@promptbook/core`
89
89
  */
90
90
  const ADMIN_GITHUB_NAME = 'hejny';
91
+ // <- TODO: [🐊] Pick the best claim
91
92
  /**
92
93
  * When the title is not provided, the default title is used
93
94
  *
@@ -120,6 +121,7 @@
120
121
  infinity: '(infinity; ∞)',
121
122
  negativeInfinity: '(negative infinity; -∞)',
122
123
  unserializable: '(unserializable value)',
124
+ circular: '(circular JSON)',
123
125
  };
124
126
  /**
125
127
  * Small number limit
@@ -159,6 +161,7 @@
159
161
  */
160
162
  const DEFAULT_MAX_EXECUTION_ATTEMPTS = 10; // <- TODO: [🤹‍♂️]
161
163
  // <- TODO: [🕝] Make also `BOOKS_DIRNAME_ALTERNATIVES`
164
+ // TODO: Just `.promptbook` in config, hardcode subfolders like `download-cache` or `execution-cache`
162
165
  /**
163
166
  * Where to store the temporary downloads
164
167
  *
@@ -210,7 +213,7 @@
210
213
  true);
211
214
  /**
212
215
  * Note: [💞] Ignore a discrepancy between file name and entity name
213
- * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
216
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteServerUrl and path into single value
214
217
  */
215
218
 
216
219
  /**
@@ -889,6 +892,54 @@
889
892
  * TODO: Maybe split `ParseError` and `ApplyError`
890
893
  */
891
894
 
895
+ /**
896
+ * This error type indicates that somewhere in the code non-Error object was thrown and it was wrapped into the `WrappedError`
897
+ *
898
+ * @public exported from `@promptbook/core`
899
+ */
900
+ class WrappedError extends Error {
901
+ constructor(whatWasThrown) {
902
+ const tag = `[🤮]`;
903
+ console.error(tag, whatWasThrown);
904
+ super(spaceTrim.spaceTrim(`
905
+ Non-Error object was thrown
906
+
907
+ Note: Look for ${tag} in the console for more details
908
+ Please report issue on ${ADMIN_EMAIL}
909
+ `));
910
+ this.name = 'WrappedError';
911
+ Object.setPrototypeOf(this, WrappedError.prototype);
912
+ }
913
+ }
914
+
915
+ /**
916
+ * Helper used in catch blocks to assert that the error is an instance of `Error`
917
+ *
918
+ * @param whatWasThrown Any object that was thrown
919
+ * @returns Nothing if the error is an instance of `Error`
920
+ * @throws `WrappedError` or `UnexpectedError` if the error is not standard
921
+ *
922
+ * @private within the repository
923
+ */
924
+ function assertsError(whatWasThrown) {
925
+ // Case 1: Handle error which was rethrown as `WrappedError`
926
+ if (whatWasThrown instanceof WrappedError) {
927
+ const wrappedError = whatWasThrown;
928
+ throw wrappedError;
929
+ }
930
+ // Case 2: Handle unexpected errors
931
+ if (whatWasThrown instanceof UnexpectedError) {
932
+ const unexpectedError = whatWasThrown;
933
+ throw unexpectedError;
934
+ }
935
+ // Case 3: Handle standard errors - keep them up to consumer
936
+ if (whatWasThrown instanceof Error) {
937
+ return;
938
+ }
939
+ // Case 4: Handle non-standard errors - wrap them into `WrappedError` and throw
940
+ throw new WrappedError(whatWasThrown);
941
+ }
942
+
892
943
  /**
893
944
  * Function isValidJsonString will tell you if the string is valid JSON or not
894
945
  *
@@ -900,9 +951,7 @@
900
951
  return true;
901
952
  }
902
953
  catch (error) {
903
- if (!(error instanceof Error)) {
904
- throw error;
905
- }
954
+ assertsError(error);
906
955
  if (error.message.includes('Unexpected token')) {
907
956
  return false;
908
957
  }
@@ -1255,9 +1304,7 @@
1255
1304
  JSON.stringify(value); // <- TODO: [0]
1256
1305
  }
1257
1306
  catch (error) {
1258
- if (!(error instanceof Error)) {
1259
- throw error;
1260
- }
1307
+ assertsError(error);
1261
1308
  throw new UnexpectedError(spaceTrim__default["default"]((block) => `
1262
1309
  \`${name}\` is not serializable
1263
1310
 
@@ -2046,7 +2093,7 @@
2046
2093
  }
2047
2094
  }
2048
2095
  /**
2049
- * TODO: !!!!!! Add id to all errors
2096
+ * TODO: [🧠][🌂] Add id to all errors
2050
2097
  */
2051
2098
 
2052
2099
  /**
@@ -2146,6 +2193,19 @@
2146
2193
  }
2147
2194
  }
2148
2195
 
2196
+ /**
2197
+ * AuthenticationError is thrown from login function which is dependency of remote server
2198
+ *
2199
+ * @public exported from `@promptbook/core`
2200
+ */
2201
+ class AuthenticationError extends Error {
2202
+ constructor(message) {
2203
+ super(message);
2204
+ this.name = 'AuthenticationError';
2205
+ Object.setPrototypeOf(this, AuthenticationError.prototype);
2206
+ }
2207
+ }
2208
+
2149
2209
  /**
2150
2210
  * This error indicates that the pipeline collection cannot be propperly loaded
2151
2211
  *
@@ -2211,6 +2271,19 @@
2211
2271
  }
2212
2272
  }
2213
2273
 
2274
+ /**
2275
+ * Error thrown when a fetch request fails
2276
+ *
2277
+ * @public exported from `@promptbook/core`
2278
+ */
2279
+ class PromptbookFetchError extends Error {
2280
+ constructor(message) {
2281
+ super(message);
2282
+ this.name = 'PromptbookFetchError';
2283
+ Object.setPrototypeOf(this, PromptbookFetchError.prototype);
2284
+ }
2285
+ }
2286
+
2214
2287
  /**
2215
2288
  * Index of all custom errors
2216
2289
  *
@@ -2231,7 +2304,10 @@
2231
2304
  PipelineExecutionError,
2232
2305
  PipelineLogicError,
2233
2306
  PipelineUrlError,
2307
+ AuthenticationError,
2308
+ PromptbookFetchError,
2234
2309
  UnexpectedError,
2310
+ WrappedError,
2235
2311
  // TODO: [🪑]> VersionMismatchError,
2236
2312
  };
2237
2313
  /**
@@ -2370,8 +2446,8 @@
2370
2446
  updatedAt = new Date();
2371
2447
  errors.push(...executionResult.errors);
2372
2448
  warnings.push(...executionResult.warnings);
2373
- // <- TODO: !!! Only unique errors and warnings should be added (or filtered)
2374
- // TODO: [🧠] !!! errors, warning, isSuccessful are redundant both in `ExecutionTask` and `ExecutionTask.currentValue`
2449
+ // <- TODO: [🌂] Only unique errors and warnings should be added (or filtered)
2450
+ // TODO: [🧠] !! errors, warning, isSuccessful are redundant both in `ExecutionTask` and `ExecutionTask.currentValue`
2375
2451
  // Also maybe move `ExecutionTask.currentValue.usage` -> `ExecutionTask.usage`
2376
2452
  // And delete `ExecutionTask.currentValue.preparedPipeline`
2377
2453
  assertsTaskSuccessful(executionResult);
@@ -2381,6 +2457,7 @@
2381
2457
  partialResultSubject.next(executionResult);
2382
2458
  }
2383
2459
  catch (error) {
2460
+ assertsError(error);
2384
2461
  status = 'ERROR';
2385
2462
  errors.push(error);
2386
2463
  partialResultSubject.error(error);
@@ -2447,6 +2524,10 @@
2447
2524
 
2448
2525
  Cannot serialize error with name "${name}"
2449
2526
 
2527
+ Authors of Promptbook probably forgot to add this error into the list of errors:
2528
+ https://github.com/webgptorg/promptbook/blob/main/src/errors/0-index.ts
2529
+
2530
+
2450
2531
  ${block(stack || message)}
2451
2532
 
2452
2533
  `));
@@ -2768,14 +2849,15 @@
2768
2849
  }
2769
2850
  }
2770
2851
  catch (error) {
2771
- if (!(error instanceof Error) || error instanceof UnexpectedError) {
2852
+ assertsError(error);
2853
+ if (error instanceof UnexpectedError) {
2772
2854
  throw error;
2773
2855
  }
2774
2856
  errors.push({ llmExecutionTools, error });
2775
2857
  }
2776
2858
  }
2777
2859
  if (errors.length === 1) {
2778
- throw errors[0];
2860
+ throw errors[0].error;
2779
2861
  }
2780
2862
  else if (errors.length > 1) {
2781
2863
  throw new PipelineExecutionError(
@@ -3223,17 +3305,22 @@
3223
3305
  /**
3224
3306
  * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
3225
3307
  *
3226
- * @private as default `fetch` function used in Promptbook scrapers
3308
+ * @public exported from `@promptbook/core`
3227
3309
  */
3228
- const scraperFetch = async (url, init) => {
3310
+ const promptbookFetch = async (urlOrRequest, init) => {
3229
3311
  try {
3230
- return await fetch(url, init);
3312
+ return await fetch(urlOrRequest, init);
3231
3313
  }
3232
3314
  catch (error) {
3233
- if (!(error instanceof Error)) {
3234
- throw error;
3315
+ assertsError(error);
3316
+ let url;
3317
+ if (typeof urlOrRequest === 'string') {
3318
+ url = urlOrRequest;
3319
+ }
3320
+ else if (urlOrRequest instanceof Request) {
3321
+ url = urlOrRequest.url;
3235
3322
  }
3236
- throw new KnowledgeScrapeError(spaceTrim__default["default"]((block) => `
3323
+ throw new PromptbookFetchError(spaceTrim__default["default"]((block) => `
3237
3324
  Can not fetch "${url}"
3238
3325
 
3239
3326
  Fetch error:
@@ -3254,7 +3341,7 @@
3254
3341
  async function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
3255
3342
  // console.log('!! makeKnowledgeSourceHandler', knowledgeSource);
3256
3343
  var _a;
3257
- const { fetch = scraperFetch } = tools;
3344
+ const { fetch = promptbookFetch } = tools;
3258
3345
  const { knowledgeSourceContent } = knowledgeSource;
3259
3346
  let { name } = knowledgeSource;
3260
3347
  const { rootDirname = null,
@@ -3456,9 +3543,7 @@
3456
3543
  knowledgePreparedUnflatten[index] = pieces;
3457
3544
  }
3458
3545
  catch (error) {
3459
- if (!(error instanceof Error)) {
3460
- throw error;
3461
- }
3546
+ assertsError(error);
3462
3547
  console.warn(error);
3463
3548
  // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
3464
3549
  }
@@ -3750,13 +3835,19 @@
3750
3835
  return value.toISOString();
3751
3836
  }
3752
3837
  else {
3753
- return JSON.stringify(value);
3838
+ try {
3839
+ return JSON.stringify(value);
3840
+ }
3841
+ catch (error) {
3842
+ if (error instanceof TypeError && error.message.includes('circular structure')) {
3843
+ return VALUE_STRINGS.circular;
3844
+ }
3845
+ throw error;
3846
+ }
3754
3847
  }
3755
3848
  }
3756
3849
  catch (error) {
3757
- if (!(error instanceof Error)) {
3758
- throw error;
3759
- }
3850
+ assertsError(error);
3760
3851
  console.error(error);
3761
3852
  return VALUE_STRINGS.unserializable;
3762
3853
  }
@@ -3813,9 +3904,7 @@
3813
3904
  }
3814
3905
  }
3815
3906
  catch (error) {
3816
- if (!(error instanceof Error)) {
3817
- throw error;
3818
- }
3907
+ assertsError(error);
3819
3908
  throw new ParseError(spaceTrim.spaceTrim((block) => `
3820
3909
  Can not extract variables from the script
3821
3910
  ${block(error.stack || error.message)}
@@ -4680,9 +4769,7 @@
4680
4769
  break scripts;
4681
4770
  }
4682
4771
  catch (error) {
4683
- if (!(error instanceof Error)) {
4684
- throw error;
4685
- }
4772
+ assertsError(error);
4686
4773
  if (error instanceof UnexpectedError) {
4687
4774
  throw error;
4688
4775
  }
@@ -4752,9 +4839,7 @@
4752
4839
  break scripts;
4753
4840
  }
4754
4841
  catch (error) {
4755
- if (!(error instanceof Error)) {
4756
- throw error;
4757
- }
4842
+ assertsError(error);
4758
4843
  if (error instanceof UnexpectedError) {
4759
4844
  throw error;
4760
4845
  }
@@ -5375,9 +5460,7 @@
5375
5460
  await Promise.all(resolving);
5376
5461
  }
5377
5462
  catch (error /* <- Note: [3] */) {
5378
- if (!(error instanceof Error)) {
5379
- throw error;
5380
- }
5463
+ assertsError(error);
5381
5464
  // Note: No need to rethrow UnexpectedError
5382
5465
  // if (error instanceof UnexpectedError) {
5383
5466
  // Note: Count usage, [🧠] Maybe put to separate function executionReportJsonToUsage + DRY [🤹‍♂️]