@promptbook/types 0.88.0-1 → 0.88.0-11

package/README.md

@@ -141,6 +141,14 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
   </tbody>
 </table>
 
+Hello world examples:
+
+-   [Hello world](https://github.com/webgptorg/hello-world)
+-   [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
+-   [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
+
+
+
 We also have a community of developers and users of **Promptbook**:
 
 -   [Discord community](https://discord.gg/x3QWNaa89N)
@@ -307,16 +315,9 @@ Or you can install them separately:
 
 ## 📚 Dictionary
 
-
-
-
-
-
-### 📚 Dictionary
-
 The following glossary is used to clarify certain concepts:
 
-#### General LLM / AI terms
+### General LLM / AI terms
 
 -   **Prompt drift** is a phenomenon where the AI model starts to generate outputs that are not aligned with the original prompt. This can happen due to the model's training data, the prompt's wording, or the model's architecture.
 -   **Pipeline, workflow or chain** is a sequence of tasks that are executed in a specific order. In the context of AI, a pipeline can refer to a sequence of AI models that are used to process data.
@@ -329,11 +330,11 @@ The following glossary is used to clarify certain concepts:
 
 
 
-_Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
+_Note: This section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
 
 
-#### 💯 Core concepts
+### 💯 Core concepts
 
 -   [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
 -   [📯 Pipeline](https://github.com/webgptorg/promptbook/discussions/64)
@@ -346,7 +347,7 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
 -   [🔣 Words not tokens](https://github.com/webgptorg/promptbook/discussions/29)
 -   [☯ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32)
 
-##### Advanced concepts
+#### Advanced concepts
 
 -   [📚 Knowledge (Retrieval-augmented generation)](https://github.com/webgptorg/promptbook/discussions/41)
 -   [🌏 Remote server](https://github.com/webgptorg/promptbook/discussions/89)
@@ -363,17 +364,9 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
 
 
 
-### Terms specific to Promptbook TypeScript implementation
-
--   Anonymous mode
--   Application mode
-
+## 🚂 Promptbook Engine
 
-
-## 🔌 Usage in Typescript / Javascript
-
--   [Simple usage](./examples/usage/simple-script)
--   [Usage with client and remote server](./examples/usage/remote)
+![Schema of Promptbook Engine](./documents/promptbook-engine.svg)
 
 ## ➕➖ When to use Promptbook?
 
@@ -439,13 +432,13 @@ See [TODO.md](./TODO.md)
 <div style="display: flex; align-items: center; gap: 20px;">
 
   <a href="https://promptbook.studio/">
-    <img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="100">
+    <img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="70">
   </a>
 
   <a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
-    <img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="100">
+    <img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="70">
   </a>
-
+  
 </div>
 
 ## 🖋️ Contributing

package/esm/typings/src/_packages/types.index.d.ts

@@ -40,6 +40,7 @@ import type { ExecutionReportString } from '../execution/execution-report/Execut
 import type { ExecutionReportStringOptions } from '../execution/execution-report/ExecutionReportStringOptions';
 import type { ExecutionTask } from '../execution/ExecutionTask';
 import type { PreparationTask } from '../execution/ExecutionTask';
+import type { task_status } from '../execution/ExecutionTask';
 import type { AbstractTask } from '../execution/ExecutionTask';
 import type { Task } from '../execution/ExecutionTask';
 import type { ExecutionTools } from '../execution/ExecutionTools';
@@ -322,6 +323,7 @@ export type { ExecutionReportString };
 export type { ExecutionReportStringOptions };
 export type { ExecutionTask };
 export type { PreparationTask };
+export type { task_status };
 export type { AbstractTask };
 export type { Task };
 export type { ExecutionTools };

package/esm/typings/src/_packages/utils.index.d.ts

@@ -62,6 +62,7 @@ import { clonePipeline } from '../utils/serialization/clonePipeline';
 import { deepClone } from '../utils/serialization/deepClone';
 import { exportJson } from '../utils/serialization/exportJson';
 import { isSerializableAsJson } from '../utils/serialization/isSerializableAsJson';
+import { jsonStringsToJsons } from '../utils/serialization/jsonStringsToJsons';
 import { difference } from '../utils/sets/difference';
 import { intersection } from '../utils/sets/intersection';
 import { union } from '../utils/sets/union';
@@ -143,6 +144,7 @@ export { clonePipeline };
 export { deepClone };
 export { exportJson };
 export { isSerializableAsJson };
+export { jsonStringsToJsons };
 export { difference };
 export { intersection };
 export { union };

package/esm/typings/src/cli/cli-commands/common/handleActionErrors.d.ts

@@ -0,0 +1,11 @@
+import type { Command as Program } from 'commander';
+type actionCallbackFunction = Parameters<Program['action']>[0];
+/**
+ * Wraps action to handle error console logging and exit process with error code
+ *
+ * @param action Action to be wrapped in error handling
+ * @returns Wrapped action
+ * @private internal helper function for CLI commands
+ */
+export declare function handleActionErrors(action: actionCallbackFunction): actionCallbackFunction;
+export {};

package/esm/typings/src/execution/ExecutionTask.d.ts

@@ -40,6 +40,10 @@ export type PreparationTask = AbstractTask<PipelineExecutorResult> & {
     readonly taskType: 'PREPARATION';
     readonly taskId: `prep-${task_id}`;
 };
+/**
+ * Status of a task
+ */
+export type task_status = 'RUNNING' | 'FINISHED' | 'ERROR';
 /**
  * Base interface for all task types
  */
@@ -52,6 +56,18 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      * Unique identifier for the task
      */
     readonly taskId: task_id;
+    /**
+     * Status of the task
+     */
+    readonly status: task_status;
+    /**
+     * Date when the task was created
+     */
+    readonly createdAt: Date;
+    /**
+     * Date when the task was last updated
+     */
+    readonly updatedAt: Date;
     /**
      * Gets a promise that resolves with the task result
      */
@@ -66,6 +82,14 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      * Gets just the current value which is mutated during the task processing
      */
     currentValue: PartialDeep<TTaskResult>;
+    /**
+     * List of errors that occurred during the task processing
+     */
+    readonly errors: Array<Error>;
+    /**
+     * List of warnings that occurred during the task processing
+     */
+    readonly warnings: Array<Error>;
 };
 export type Task = ExecutionTask | PreparationTask;
 export {};

package/esm/typings/src/utils/serialization/jsonStringsToJsons.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Recursively converts JSON strings to JSON objects
+
+ * @public exported from `@promptbook/utils`
+ */
+export declare function jsonStringsToJsons<T>(object: T): T;
+/**
+ * TODO: Type the return type correctly
+ */

package/esm/typings/src/utils/serialization/jsonStringsToJsons.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.88.0-1",
+    "version": "0.88.0-11",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -45,6 +45,6 @@
     "homepage": "https://ptbk.io/",
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.88.0-1"
+        "@promptbook/core": "0.88.0-11"
     }
 }