@promptbook/core 0.86.31 → 0.88.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.
@@ -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 };
@@ -62,6 +62,7 @@ import { clonePipeline } from '../utils/serialization/clonePipeline';
62
62
  import { deepClone } from '../utils/serialization/deepClone';
63
63
  import { exportJson } from '../utils/serialization/exportJson';
64
64
  import { isSerializableAsJson } from '../utils/serialization/isSerializableAsJson';
65
+ import { jsonStringsToJsons } from '../utils/serialization/jsonStringsToJsons';
65
66
  import { difference } from '../utils/sets/difference';
66
67
  import { intersection } from '../utils/sets/intersection';
67
68
  import { union } from '../utils/sets/union';
@@ -143,6 +144,7 @@ export { clonePipeline };
143
144
  export { deepClone };
144
145
  export { exportJson };
145
146
  export { isSerializableAsJson };
147
+ export { jsonStringsToJsons };
146
148
  export { difference };
147
149
  export { intersection };
148
150
  export { union };
@@ -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
  /**
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Recursively converts JSON strings to JSON objects
3
+
4
+ * @public exported from `@promptbook/utils`
5
+ */
6
+ export declare function jsonStringsToJsons<T>(object: T): T;
7
+ /**
8
+ * TODO: Type the return type correctly
9
+ */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/core",
3
- "version": "0.86.31",
3
+ "version": "0.88.0-10",
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,
package/umd/index.umd.js CHANGED
@@ -27,7 +27,7 @@
27
27
  * @generated
28
28
  * @see https://github.com/webgptorg/promptbook
29
29
  */
30
- const PROMPTBOOK_ENGINE_VERSION = '0.86.31';
30
+ const PROMPTBOOK_ENGINE_VERSION = '0.88.0-10';
31
31
  /**
32
32
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
33
33
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1814,6 +1814,36 @@
1814
1814
  * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
1815
1815
  */
1816
1816
 
1817
+ /**
1818
+ * Recursively converts JSON strings to JSON objects
1819
+
1820
+ * @public exported from `@promptbook/utils`
1821
+ */
1822
+ function jsonStringsToJsons(object) {
1823
+ if (object === null) {
1824
+ return object;
1825
+ }
1826
+ if (Array.isArray(object)) {
1827
+ return object.map(jsonStringsToJsons);
1828
+ }
1829
+ if (typeof object !== 'object') {
1830
+ return object;
1831
+ }
1832
+ const newObject = { ...object };
1833
+ for (const [key, value] of Object.entries(object)) {
1834
+ if (typeof value === 'string' && isValidJsonString(value)) {
1835
+ newObject[key] = JSON.parse(value);
1836
+ }
1837
+ else {
1838
+ newObject[key] = jsonStringsToJsons(value);
1839
+ }
1840
+ }
1841
+ return newObject;
1842
+ }
1843
+ /**
1844
+ * TODO: Type the return type correctly
1845
+ */
1846
+
1817
1847
  /**
1818
1848
  * This error indicates errors during the execution of the pipeline
1819
1849
  *
@@ -2079,21 +2109,43 @@
2079
2109
  function createTask(options) {
2080
2110
  const { taskType, taskProcessCallback } = options;
2081
2111
  const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts */)}`;
2082
- const partialResultSubject = new rxjs.BehaviorSubject({});
2112
+ let status = 'RUNNING';
2113
+ const createdAt = new Date();
2114
+ let updatedAt = createdAt;
2115
+ const errors = [];
2116
+ const warnings = [];
2117
+ let currentValue = {};
2118
+ const partialResultSubject = new rxjs.Subject();
2119
+ // <- Note: Not using `BehaviorSubject` because on error we can't access the last value
2083
2120
  const finalResultPromise = /* not await */ taskProcessCallback((newOngoingResult) => {
2121
+ Object.assign(currentValue, newOngoingResult);
2122
+ // <- TODO: assign deep
2084
2123
  partialResultSubject.next(newOngoingResult);
2085
2124
  });
2086
2125
  finalResultPromise
2087
2126
  .catch((error) => {
2127
+ errors.push(error);
2088
2128
  partialResultSubject.error(error);
2089
2129
  })
2090
- .then((value) => {
2091
- if (value) {
2130
+ .then((executionResult) => {
2131
+ if (executionResult) {
2092
2132
  try {
2093
- assertsTaskSuccessful(value);
2094
- partialResultSubject.next(value);
2133
+ updatedAt = new Date();
2134
+ errors.push(...executionResult.errors);
2135
+ warnings.push(...executionResult.warnings);
2136
+ // <- TODO: !!! Only unique errors and warnings should be added (or filtered)
2137
+ // TODO: [🧠] !!! errors, warning, isSuccessful are redundant both in `ExecutionTask` and `ExecutionTask.currentValue`
2138
+ // Also maybe move `ExecutionTask.currentValue.usage` -> `ExecutionTask.usage`
2139
+ // And delete `ExecutionTask.currentValue.preparedPipeline`
2140
+ assertsTaskSuccessful(executionResult);
2141
+ status = 'FINISHED';
2142
+ currentValue = jsonStringsToJsons(executionResult);
2143
+ // <- TODO: [🧠] Is this a good idea to convert JSON strins to JSONs?
2144
+ partialResultSubject.next(executionResult);
2095
2145
  }
2096
2146
  catch (error) {
2147
+ status = 'ERROR';
2148
+ errors.push(error);
2097
2149
  partialResultSubject.error(error);
2098
2150
  }
2099
2151
  }
@@ -2110,12 +2162,33 @@
2110
2162
  return {
2111
2163
  taskType,
2112
2164
  taskId,
2165
+ get status() {
2166
+ return status;
2167
+ // <- Note: [1] Theese must be getters to allow changing the value in the future
2168
+ },
2169
+ get createdAt() {
2170
+ return createdAt;
2171
+ // <- Note: [1]
2172
+ },
2173
+ get updatedAt() {
2174
+ return updatedAt;
2175
+ // <- Note: [1]
2176
+ },
2113
2177
  asPromise,
2114
2178
  asObservable() {
2115
2179
  return partialResultSubject.asObservable();
2116
2180
  },
2181
+ get errors() {
2182
+ return errors;
2183
+ // <- Note: [1]
2184
+ },
2185
+ get warnings() {
2186
+ return warnings;
2187
+ // <- Note: [1]
2188
+ },
2117
2189
  get currentValue() {
2118
- return partialResultSubject.value;
2190
+ return currentValue;
2191
+ // <- Note: [1]
2119
2192
  },
2120
2193
  };
2121
2194
  }
@@ -2331,7 +2404,7 @@
2331
2404
  * @param script from which to extract the variables
2332
2405
  * @returns the list of variable names
2333
2406
  * @throws {ParseError} if the script is invalid
2334
- * @public exported from `@promptbook/execute-javascript`
2407
+ * @public exported from `@promptbook/javascript`
2335
2408
  */
2336
2409
  function extractVariablesFromJavascript(script) {
2337
2410
  const variables = new Set();
@@ -3904,7 +3977,7 @@
3904
3977
  Last result:
3905
3978
  ${block($ongoingTaskResult.$resultString === null
3906
3979
  ? 'null'
3907
- : $ongoingTaskResult.$resultString
3980
+ : spaceTrim.spaceTrim($ongoingTaskResult.$resultString)
3908
3981
  .split('\n')
3909
3982
  .map((line) => `> ${line}`)
3910
3983
  .join('\n'))}