@promptbook/markdown-utils 0.88.0-1 → 0.88.0-11

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.
@@ -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,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/markdown-utils",
3
- "version": "0.88.0-1",
3
+ "version": "0.88.0-11",
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
@@ -25,7 +25,7 @@
25
25
  * @generated
26
26
  * @see https://github.com/webgptorg/promptbook
27
27
  */
28
- const PROMPTBOOK_ENGINE_VERSION = '0.88.0-1';
28
+ const PROMPTBOOK_ENGINE_VERSION = '0.88.0-11';
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
@@ -1741,6 +1741,36 @@
1741
1741
  * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
1742
1742
  */
1743
1743
 
1744
+ /**
1745
+ * Recursively converts JSON strings to JSON objects
1746
+
1747
+ * @public exported from `@promptbook/utils`
1748
+ */
1749
+ function jsonStringsToJsons(object) {
1750
+ if (object === null) {
1751
+ return object;
1752
+ }
1753
+ if (Array.isArray(object)) {
1754
+ return object.map(jsonStringsToJsons);
1755
+ }
1756
+ if (typeof object !== 'object') {
1757
+ return object;
1758
+ }
1759
+ const newObject = { ...object };
1760
+ for (const [key, value] of Object.entries(object)) {
1761
+ if (typeof value === 'string' && isValidJsonString(value)) {
1762
+ newObject[key] = JSON.parse(value);
1763
+ }
1764
+ else {
1765
+ newObject[key] = jsonStringsToJsons(value);
1766
+ }
1767
+ }
1768
+ return newObject;
1769
+ }
1770
+ /**
1771
+ * TODO: Type the return type correctly
1772
+ */
1773
+
1744
1774
  /**
1745
1775
  * This error indicates problems parsing the format value
1746
1776
  *
@@ -1993,21 +2023,43 @@
1993
2023
  function createTask(options) {
1994
2024
  const { taskType, taskProcessCallback } = options;
1995
2025
  const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts */)}`;
1996
- const partialResultSubject = new rxjs.BehaviorSubject({});
2026
+ let status = 'RUNNING';
2027
+ const createdAt = new Date();
2028
+ let updatedAt = createdAt;
2029
+ const errors = [];
2030
+ const warnings = [];
2031
+ let currentValue = {};
2032
+ const partialResultSubject = new rxjs.Subject();
2033
+ // <- Note: Not using `BehaviorSubject` because on error we can't access the last value
1997
2034
  const finalResultPromise = /* not await */ taskProcessCallback((newOngoingResult) => {
2035
+ Object.assign(currentValue, newOngoingResult);
2036
+ // <- TODO: assign deep
1998
2037
  partialResultSubject.next(newOngoingResult);
1999
2038
  });
2000
2039
  finalResultPromise
2001
2040
  .catch((error) => {
2041
+ errors.push(error);
2002
2042
  partialResultSubject.error(error);
2003
2043
  })
2004
- .then((value) => {
2005
- if (value) {
2044
+ .then((executionResult) => {
2045
+ if (executionResult) {
2006
2046
  try {
2007
- assertsTaskSuccessful(value);
2008
- partialResultSubject.next(value);
2047
+ updatedAt = new Date();
2048
+ errors.push(...executionResult.errors);
2049
+ warnings.push(...executionResult.warnings);
2050
+ // <- TODO: !!! Only unique errors and warnings should be added (or filtered)
2051
+ // TODO: [🧠] !!! errors, warning, isSuccessful are redundant both in `ExecutionTask` and `ExecutionTask.currentValue`
2052
+ // Also maybe move `ExecutionTask.currentValue.usage` -> `ExecutionTask.usage`
2053
+ // And delete `ExecutionTask.currentValue.preparedPipeline`
2054
+ assertsTaskSuccessful(executionResult);
2055
+ status = 'FINISHED';
2056
+ currentValue = jsonStringsToJsons(executionResult);
2057
+ // <- TODO: [🧠] Is this a good idea to convert JSON strins to JSONs?
2058
+ partialResultSubject.next(executionResult);
2009
2059
  }
2010
2060
  catch (error) {
2061
+ status = 'ERROR';
2062
+ errors.push(error);
2011
2063
  partialResultSubject.error(error);
2012
2064
  }
2013
2065
  }
@@ -2024,12 +2076,33 @@
2024
2076
  return {
2025
2077
  taskType,
2026
2078
  taskId,
2079
+ get status() {
2080
+ return status;
2081
+ // <- Note: [1] Theese must be getters to allow changing the value in the future
2082
+ },
2083
+ get createdAt() {
2084
+ return createdAt;
2085
+ // <- Note: [1]
2086
+ },
2087
+ get updatedAt() {
2088
+ return updatedAt;
2089
+ // <- Note: [1]
2090
+ },
2027
2091
  asPromise,
2028
2092
  asObservable() {
2029
2093
  return partialResultSubject.asObservable();
2030
2094
  },
2095
+ get errors() {
2096
+ return errors;
2097
+ // <- Note: [1]
2098
+ },
2099
+ get warnings() {
2100
+ return warnings;
2101
+ // <- Note: [1]
2102
+ },
2031
2103
  get currentValue() {
2032
- return partialResultSubject.value;
2104
+ return currentValue;
2105
+ // <- Note: [1]
2033
2106
  },
2034
2107
  };
2035
2108
  }
@@ -4688,7 +4761,7 @@
4688
4761
  Last result:
4689
4762
  ${block($ongoingTaskResult.$resultString === null
4690
4763
  ? 'null'
4691
- : $ongoingTaskResult.$resultString
4764
+ : spaceTrim.spaceTrim($ongoingTaskResult.$resultString)
4692
4765
  .split('\n')
4693
4766
  .map((line) => `> ${line}`)
4694
4767
  .join('\n'))}