@promptbook/types 0.100.0-1 → 0.100.0-10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/typings/src/config.d.ts +0 -10
- package/esm/typings/src/version.d.ts +1 -1
- package/esm/typings/src/wizard/wizard.d.ts +14 -4
- package/package.json +2 -2
- package/esm/typings/src/remote-server/connection-improvements.test.d.ts +0 -1
- package/esm/typings/src/remote-server/utils/connectionProgress.d.ts +0 -72
|
@@ -138,9 +138,6 @@ export declare const SMALL_NUMBER = 0.001;
|
|
|
138
138
|
/**
|
|
139
139
|
* Timeout for the connections in milliseconds
|
|
140
140
|
*
|
|
141
|
-
* Note: Increased from 7 seconds to 30 seconds to accommodate OAuth flows
|
|
142
|
-
* like Facebook login which may require user interaction and redirects
|
|
143
|
-
*
|
|
144
141
|
* @private within the repository - too low-level in comparison with other `MAX_...`
|
|
145
142
|
*/
|
|
146
143
|
export declare const CONNECTION_TIMEOUT_MS: number;
|
|
@@ -150,13 +147,6 @@ export declare const CONNECTION_TIMEOUT_MS: number;
|
|
|
150
147
|
* @private within the repository - too low-level in comparison with other `MAX_...`
|
|
151
148
|
*/
|
|
152
149
|
export declare const CONNECTION_RETRIES_LIMIT = 5;
|
|
153
|
-
/**
|
|
154
|
-
* Timeout specifically for OAuth authentication flows in milliseconds
|
|
155
|
-
* OAuth flows typically require more time due to user interaction and redirects
|
|
156
|
-
*
|
|
157
|
-
* @private within the repository - too low-level in comparison with other `MAX_...`
|
|
158
|
-
*/
|
|
159
|
-
export declare const OAUTH_TIMEOUT_MS: number;
|
|
160
150
|
/**
|
|
161
151
|
* Short time interval to prevent race conditions in milliseconds
|
|
162
152
|
*
|
|
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
|
|
|
15
15
|
export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
|
|
16
16
|
/**
|
|
17
17
|
* Represents the version string of the Promptbook engine.
|
|
18
|
-
* It follows semantic versioning (e.g., `0.100.0-
|
|
18
|
+
* It follows semantic versioning (e.g., `0.100.0-9`).
|
|
19
19
|
*
|
|
20
20
|
* @generated
|
|
21
21
|
*/
|
|
@@ -6,6 +6,15 @@ import type { InputParameters } from '../types/typeAliases';
|
|
|
6
6
|
import type { string_filename } from '../types/typeAliases';
|
|
7
7
|
import type { string_parameter_value } from '../types/typeAliases';
|
|
8
8
|
import type { string_pipeline_url } from '../types/typeAliases';
|
|
9
|
+
/**
|
|
10
|
+
* Options for wizard methods
|
|
11
|
+
*/
|
|
12
|
+
interface WizardOptions {
|
|
13
|
+
/**
|
|
14
|
+
* Whether to enable verbose logging
|
|
15
|
+
*/
|
|
16
|
+
isVerbose?: boolean;
|
|
17
|
+
}
|
|
9
18
|
/**
|
|
10
19
|
* Wizard for simple usage of the Promptbook
|
|
11
20
|
* Look at `wizard` for more details
|
|
@@ -26,7 +35,7 @@ declare class Wizard {
|
|
|
26
35
|
*
|
|
27
36
|
* Note: This works similar to the `ptbk run` command
|
|
28
37
|
*/
|
|
29
|
-
execute(book: string_pipeline_url | string_filename | PipelineString, inputParameters: InputParameters): Promise<{
|
|
38
|
+
execute(book: string_pipeline_url | string_filename | PipelineString, inputParameters: InputParameters, options?: WizardOptions): Promise<{
|
|
30
39
|
/**
|
|
31
40
|
* Simple result of the execution
|
|
32
41
|
*/
|
|
@@ -36,9 +45,9 @@ declare class Wizard {
|
|
|
36
45
|
/**
|
|
37
46
|
* Provides the tools automatically for the Node.js environment
|
|
38
47
|
*
|
|
39
|
-
* @param
|
|
48
|
+
* @param options
|
|
40
49
|
*/
|
|
41
|
-
getExecutionTools(): Promise<Required<Pick<ExecutionTools, 'fs' | 'fetch'>>>;
|
|
50
|
+
getExecutionTools(options?: WizardOptions): Promise<Required<Pick<ExecutionTools, 'fs' | 'fetch'>>>;
|
|
42
51
|
/**
|
|
43
52
|
* Load book from the source
|
|
44
53
|
*
|
|
@@ -49,8 +58,9 @@ declare class Wizard {
|
|
|
49
58
|
* 3) As a string
|
|
50
59
|
*
|
|
51
60
|
* @param pipelineSource
|
|
61
|
+
* @param options
|
|
52
62
|
*/
|
|
53
|
-
getCompiledBook(pipelineSource: string_filename | string_pipeline_url | PipelineString): Promise<PipelineJson>;
|
|
63
|
+
getCompiledBook(pipelineSource: string_filename | string_pipeline_url | PipelineString, options?: WizardOptions): Promise<PipelineJson>;
|
|
54
64
|
}
|
|
55
65
|
/**
|
|
56
66
|
* Wizard for simple usage of the Promptbook
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@promptbook/types",
|
|
3
|
-
"version": "0.100.0-
|
|
3
|
+
"version": "0.100.0-10",
|
|
4
4
|
"description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
|
|
5
5
|
"private": false,
|
|
6
6
|
"sideEffects": false,
|
|
@@ -92,6 +92,6 @@
|
|
|
92
92
|
},
|
|
93
93
|
"typings": "./esm/typings/src/_packages/types.index.d.ts",
|
|
94
94
|
"peerDependencies": {
|
|
95
|
-
"@promptbook/core": "0.100.0-
|
|
95
|
+
"@promptbook/core": "0.100.0-10"
|
|
96
96
|
}
|
|
97
97
|
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1,72 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Connection progress utilities for better user experience during authentication
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* Connection status types for better progress indication
|
|
6
|
-
*
|
|
7
|
-
* @private
|
|
8
|
-
*/
|
|
9
|
-
export type ConnectionStatus = 'connecting' | 'authenticating' | 'connected' | 'disconnected' | 'error' | 'timeout';
|
|
10
|
-
/**
|
|
11
|
-
* Progress callback function type for connection status updates
|
|
12
|
-
*
|
|
13
|
-
* @private
|
|
14
|
-
*/
|
|
15
|
-
export type ConnectionProgressCallback = (status: ConnectionStatus, message?: string) => void;
|
|
16
|
-
/**
|
|
17
|
-
* Enhanced connection options with progress reporting
|
|
18
|
-
*
|
|
19
|
-
* @private
|
|
20
|
-
*/
|
|
21
|
-
export interface ConnectionProgressOptions {
|
|
22
|
-
onProgress?: ConnectionProgressCallback;
|
|
23
|
-
enableProgressReporting?: boolean;
|
|
24
|
-
}
|
|
25
|
-
/**
|
|
26
|
-
* Default progress messages for different connection states
|
|
27
|
-
*
|
|
28
|
-
* @private
|
|
29
|
-
*/
|
|
30
|
-
export declare const DEFAULT_PROGRESS_MESSAGES: {
|
|
31
|
-
readonly connecting: "Connecting to Promptbook server...";
|
|
32
|
-
readonly authenticating: "Authenticating with social provider (Facebook, Google, etc.)...";
|
|
33
|
-
readonly connected: "Successfully connected to Promptbook server";
|
|
34
|
-
readonly disconnected: "Disconnected from Promptbook server";
|
|
35
|
-
readonly error: "Connection failed";
|
|
36
|
-
readonly timeout: "Connection timed out - this may happen during social login flows";
|
|
37
|
-
};
|
|
38
|
-
/**
|
|
39
|
-
* Creates a progress reporter for connection status
|
|
40
|
-
* This can be used by frontend applications to show connection progress
|
|
41
|
-
*
|
|
42
|
-
* @private
|
|
43
|
-
*/
|
|
44
|
-
export declare function createConnectionProgressReporter(callback?: ConnectionProgressCallback): ConnectionProgressCallback;
|
|
45
|
-
/**
|
|
46
|
-
* Timeout constants with descriptions for different connection types
|
|
47
|
-
*
|
|
48
|
-
* @private
|
|
49
|
-
*/
|
|
50
|
-
export declare const CONNECTION_TIMEOUTS: {
|
|
51
|
-
/** Standard timeout for regular connections */
|
|
52
|
-
readonly STANDARD: number;
|
|
53
|
-
/** Extended timeout for OAuth flows that require user interaction */
|
|
54
|
-
readonly OAUTH: number;
|
|
55
|
-
/** Short timeout for quick health checks */
|
|
56
|
-
readonly HEALTH_CHECK: number;
|
|
57
|
-
};
|
|
58
|
-
/**
|
|
59
|
-
* Helper function to get appropriate timeout based on connection type
|
|
60
|
-
*
|
|
61
|
-
* @private
|
|
62
|
-
*/
|
|
63
|
-
export declare function getConnectionTimeout(type: 'standard' | 'oauth' | 'health_check'): number;
|
|
64
|
-
/**
|
|
65
|
-
* Creates a timeout wrapper with progress reporting
|
|
66
|
-
*
|
|
67
|
-
* @private
|
|
68
|
-
*/
|
|
69
|
-
export declare function createTimeoutWithProgress(timeoutMs: number, onProgress?: ConnectionProgressCallback): Promise<never>;
|
|
70
|
-
/**
|
|
71
|
-
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
72
|
-
*/
|