@promptbook/documents 0.86.31 → 0.88.0-8

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.
@@ -6,6 +6,7 @@ import { $provideLlmToolsConfigurationFromEnv } from '../llm-providers/_common/r
6
6
  import { $provideLlmToolsFromEnv } from '../llm-providers/_common/register/$provideLlmToolsFromEnv';
7
7
  import { $provideFilesystemForNode } from '../scrapers/_common/register/$provideFilesystemForNode';
8
8
  import { $provideScrapersForNode } from '../scrapers/_common/register/$provideScrapersForNode';
9
+ import { $provideScriptingForNode } from '../scrapers/_common/register/$provideScriptingForNode';
9
10
  import { FileCacheStorage } from '../storage/file-cache-storage/FileCacheStorage';
10
11
  import { $execCommand } from '../utils/execCommand/$execCommand';
11
12
  import { $execCommands } from '../utils/execCommand/$execCommands';
@@ -17,6 +18,7 @@ export { $provideLlmToolsConfigurationFromEnv };
17
18
  export { $provideLlmToolsFromEnv };
18
19
  export { $provideFilesystemForNode };
19
20
  export { $provideScrapersForNode };
21
+ export { $provideScriptingForNode };
20
22
  export { FileCacheStorage };
21
23
  export { $execCommand };
22
24
  export { $execCommands };
@@ -40,6 +40,7 @@ import type { ExecutionReportString } from '../execution/execution-report/Execut
40
40
  import type { ExecutionReportStringOptions } from '../execution/execution-report/ExecutionReportStringOptions';
41
41
  import type { ExecutionTask } from '../execution/ExecutionTask';
42
42
  import type { PreparationTask } from '../execution/ExecutionTask';
43
+ import type { task_status } from '../execution/ExecutionTask';
43
44
  import type { AbstractTask } from '../execution/ExecutionTask';
44
45
  import type { Task } from '../execution/ExecutionTask';
45
46
  import type { ExecutionTools } from '../execution/ExecutionTools';
@@ -322,6 +323,7 @@ export type { ExecutionReportString };
322
323
  export type { ExecutionReportStringOptions };
323
324
  export type { ExecutionTask };
324
325
  export type { PreparationTask };
326
+ export type { task_status };
325
327
  export type { AbstractTask };
326
328
  export type { Task };
327
329
  export type { ExecutionTools };
@@ -0,0 +1,11 @@
1
+ import type { Command as Program } from 'commander';
2
+ type actionCallbackFunction = Parameters<Program['action']>[0];
3
+ /**
4
+ * Wraps action to handle error console logging and exit process with error code
5
+ *
6
+ * @param action Action to be wrapped in error handling
7
+ * @returns Wrapped action
8
+ * @private internal helper function for CLI commands
9
+ */
10
+ export declare function handleActionErrors(action: actionCallbackFunction): actionCallbackFunction;
11
+ export {};
@@ -40,6 +40,10 @@ export type PreparationTask = AbstractTask<PipelineExecutorResult> & {
40
40
  readonly taskType: 'PREPARATION';
41
41
  readonly taskId: `prep-${task_id}`;
42
42
  };
43
+ /**
44
+ * Status of a task
45
+ */
46
+ export type task_status = 'RUNNING' | 'FINISHED' | 'ERROR';
43
47
  /**
44
48
  * Base interface for all task types
45
49
  */
@@ -52,6 +56,18 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
52
56
  * Unique identifier for the task
53
57
  */
54
58
  readonly taskId: task_id;
59
+ /**
60
+ * Status of the task
61
+ */
62
+ readonly status: task_status;
63
+ /**
64
+ * Date when the task was created
65
+ */
66
+ readonly createdAt: Date;
67
+ /**
68
+ * Date when the task was last updated
69
+ */
70
+ readonly updatedAt: Date;
55
71
  /**
56
72
  * Gets a promise that resolves with the task result
57
73
  */
@@ -66,6 +82,14 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
66
82
  * Gets just the current value which is mutated during the task processing
67
83
  */
68
84
  currentValue: PartialDeep<TTaskResult>;
85
+ /**
86
+ * List of errors that occurred during the task processing
87
+ */
88
+ readonly errors: Array<Error>;
89
+ /**
90
+ * List of warnings that occurred during the task processing
91
+ */
92
+ readonly warnings: Array<Error>;
69
93
  };
70
94
  export type Task = ExecutionTask | PreparationTask;
71
95
  export {};
@@ -0,0 +1,11 @@
1
+ import type { ScriptExecutionTools } from '../../../execution/ScriptExecutionTools';
2
+ import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
3
+ /**
4
+ * Provides script execution tools
5
+ *
6
+ * @public exported from `@promptbook/node`
7
+ */
8
+ export declare function $provideScriptingForNode(options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<ScriptExecutionTools>>;
9
+ /**
10
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
11
+ */
@@ -6,7 +6,7 @@ import type { JavascriptExecutionToolsOptions } from './JavascriptExecutionTools
6
6
  * Warning: It is used for testing and mocking
7
7
  * **NOT intended to use in the production** due to its unsafe nature, use `JavascriptExecutionTools` instead.
8
8
  *
9
- * @public exported from `@promptbook/execute-javascript`
9
+ * @public exported from `@promptbook/javascript`
10
10
  */
11
11
  export declare class JavascriptEvalExecutionTools implements ScriptExecutionTools {
12
12
  protected readonly options: JavascriptExecutionToolsOptions;
@@ -3,6 +3,6 @@ import { JavascriptEvalExecutionTools } from './JavascriptEvalExecutionTools';
3
3
  * Placeholder for better implementation of JavascriptExecutionTools - some propper sandboxing
4
4
  *
5
5
  * @alias JavascriptExecutionTools
6
- * @public exported from `@promptbook/execute-javascript`
6
+ * @public exported from `@promptbook/javascript`
7
7
  */
8
8
  export declare const JavascriptExecutionTools: typeof JavascriptEvalExecutionTools;
@@ -20,7 +20,7 @@ import { unwrapResult } from '../../utils/unwrapResult';
20
20
  /**
21
21
  * @@@
22
22
  *
23
- * @public exported from `@promptbook/execute-javascript`
23
+ * @public exported from `@promptbook/javascript`
24
24
  */
25
25
  export declare const POSTPROCESSING_FUNCTIONS: {
26
26
  spaceTrim: typeof spaceTrim;
@@ -6,7 +6,7 @@ import type { string_javascript_name } from '../../../types/typeAliases';
6
6
  * @param script from which to extract the variables
7
7
  * @returns the list of variable names
8
8
  * @throws {ParseError} if the script is invalid
9
- * @public exported from `@promptbook/execute-javascript`
9
+ * @public exported from `@promptbook/javascript`
10
10
  */
11
11
  export declare function extractVariablesFromJavascript(script: string_javascript): Set<string_javascript_name>;
12
12
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/documents",
3
- "version": "0.86.31",
3
+ "version": "0.88.0-8",
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,
@@ -47,7 +47,7 @@
47
47
  "module": "./esm/index.es.js",
48
48
  "typings": "./esm/typings/src/_packages/documents.index.d.ts",
49
49
  "peerDependencies": {
50
- "@promptbook/core": "0.86.31"
50
+ "@promptbook/core": "0.88.0-8"
51
51
  },
52
52
  "dependencies": {
53
53
  "colors": "1.4.0",
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.86.31';
29
+ const PROMPTBOOK_ENGINE_VERSION = '0.88.0-8';
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
@@ -2462,21 +2462,41 @@
2462
2462
  function createTask(options) {
2463
2463
  const { taskType, taskProcessCallback } = options;
2464
2464
  const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts */)}`;
2465
- const partialResultSubject = new rxjs.BehaviorSubject({});
2465
+ let status = 'RUNNING';
2466
+ const createdAt = new Date();
2467
+ let updatedAt = createdAt;
2468
+ const errors = [];
2469
+ const warnings = [];
2470
+ const currentValue = {};
2471
+ const partialResultSubject = new rxjs.Subject();
2472
+ // <- Note: Not using `BehaviorSubject` because on error we can't access the last value
2466
2473
  const finalResultPromise = /* not await */ taskProcessCallback((newOngoingResult) => {
2474
+ Object.assign(currentValue, newOngoingResult);
2467
2475
  partialResultSubject.next(newOngoingResult);
2468
2476
  });
2469
2477
  finalResultPromise
2470
2478
  .catch((error) => {
2479
+ errors.push(error);
2471
2480
  partialResultSubject.error(error);
2472
2481
  })
2473
- .then((value) => {
2474
- if (value) {
2482
+ .then((executionResult) => {
2483
+ if (executionResult) {
2475
2484
  try {
2476
- assertsTaskSuccessful(value);
2477
- partialResultSubject.next(value);
2485
+ updatedAt = new Date();
2486
+ errors.push(...executionResult.errors);
2487
+ warnings.push(...executionResult.warnings);
2488
+ // <- TODO: !!! Only unique errors and warnings should be added (or filtered)
2489
+ // TODO: [🧠] !!! errors, warning, isSuccessful are redundant both in `ExecutionTask` and `ExecutionTask.currentValue`
2490
+ // Also maybe move `ExecutionTask.currentValue.usage` -> `ExecutionTask.usage`
2491
+ // And delete `ExecutionTask.currentValue.preparedPipeline`
2492
+ assertsTaskSuccessful(executionResult);
2493
+ status = 'FINISHED';
2494
+ Object.assign(currentValue, executionResult);
2495
+ partialResultSubject.next(executionResult);
2478
2496
  }
2479
2497
  catch (error) {
2498
+ status = 'ERROR';
2499
+ errors.push(error);
2480
2500
  partialResultSubject.error(error);
2481
2501
  }
2482
2502
  }
@@ -2493,12 +2513,33 @@
2493
2513
  return {
2494
2514
  taskType,
2495
2515
  taskId,
2516
+ get status() {
2517
+ return status;
2518
+ // <- Note: [1] Theese must be getters to allow changing the value in the future
2519
+ },
2520
+ get createdAt() {
2521
+ return createdAt;
2522
+ // <- Note: [1]
2523
+ },
2524
+ get updatedAt() {
2525
+ return updatedAt;
2526
+ // <- Note: [1]
2527
+ },
2496
2528
  asPromise,
2497
2529
  asObservable() {
2498
2530
  return partialResultSubject.asObservable();
2499
2531
  },
2532
+ get errors() {
2533
+ return errors;
2534
+ // <- Note: [1]
2535
+ },
2536
+ get warnings() {
2537
+ return warnings;
2538
+ // <- Note: [1]
2539
+ },
2500
2540
  get currentValue() {
2501
- return partialResultSubject.value;
2541
+ return currentValue;
2542
+ // <- Note: [1]
2502
2543
  },
2503
2544
  };
2504
2545
  }
@@ -3799,7 +3840,7 @@
3799
3840
  * @param script from which to extract the variables
3800
3841
  * @returns the list of variable names
3801
3842
  * @throws {ParseError} if the script is invalid
3802
- * @public exported from `@promptbook/execute-javascript`
3843
+ * @public exported from `@promptbook/javascript`
3803
3844
  */
3804
3845
  function extractVariablesFromJavascript(script) {
3805
3846
  const variables = new Set();
@@ -4863,7 +4904,7 @@
4863
4904
  Last result:
4864
4905
  ${block($ongoingTaskResult.$resultString === null
4865
4906
  ? 'null'
4866
- : $ongoingTaskResult.$resultString
4907
+ : spaceTrim.spaceTrim($ongoingTaskResult.$resultString)
4867
4908
  .split('\n')
4868
4909
  .map((line) => `> ${line}`)
4869
4910
  .join('\n'))}