@promptbook/utils 0.61.0-28 → 0.61.0-30

package/esm/index.es.js

@@ -1969,7 +1969,7 @@ function isValidUuid(value) {
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.61.0-27';
+var PROMPTBOOK_VERSION = '0.61.0-29';
 // TODO: !!!! List here all the versions and annotate + put into script
 
 // @promptbook/utils

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

@@ -1,4 +1,5 @@
 import type { Promisable } from 'type-fest';
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 import { PipelineExecutionError } from '../errors/PipelineExecutionError';
 import type { TaskProgress } from '../types/TaskProgress';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
@@ -10,6 +11,8 @@ import type { PromptResultUsage } from './PromptResultUsage';
  *
  * It can be created with `createPipelineExecutor` function.
  *
+ * @@@ almost-JSON (what about errors)
+ *
  * @see https://github.com/webgptorg/promptbook#executor
  */
 export type PipelineExecutor = {
@@ -17,8 +20,16 @@ export type PipelineExecutor = {
 };
 /**
  * @@@
+ *
+ * @@@ almost-JSON (what about errors)
  */
 export type PipelineExecutorResult = {
+    /**
+     * Result parameters of the execution
+     *
+     * Note: If the execution was not successful, there are only some of the result parameters
+     */
+    readonly outputParameters: Parameters;
     /**
      * Whether the execution was successful, details are aviable in `executionReport`
      */
@@ -40,13 +51,14 @@ export type PipelineExecutorResult = {
      */
     readonly executionReport: ExecutionReportJson;
     /**
-     * Result parameters of the execution
+     * The prepared pipeline that was used for the execution
      *
-     * Note: If the execution was not successful, there are only some of the result parameters
+     * Note: If you called `createPipelineExecutor` with fully prepared pipeline, this is the same object as this pipeline
+     *       If you passed not fully prepared pipeline, this is same pipeline but fully prepared
      */
-    readonly outputParameters: Parameters;
+    readonly preparedPipeline: PipelineJson;
 };
 /**
  * TODO: [🧠] Should this file be in /execution or /types folder?
- * TODO: [💷] `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result
+ * TODO: [💷] `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result - BUT maybe NOT?
  */

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

@@ -20,6 +20,16 @@ type CreatePipelineExecutorSettings = {
      * @default false
      */
     readonly isVerbose?: boolean;
+    /**
+     * If you pass fully prepared pipeline, this does not matter
+     *
+     * Otherwise:
+     * If false or not set, warning is shown when pipeline is not prepared
+     * If true, warning is suppressed
+     *
+     * @default false
+     */
+    readonly isNotPreparedWarningSupressed?: boolean;
 };
 /**
  * Options for `createPipelineExecutor`
@@ -47,8 +57,6 @@ interface CreatePipelineExecutorOptions {
 export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
 export {};
 /**
- * TODO: !!!!! return `preparedPipeline` from execution
- * TODO: !!!!! `isNotPreparedWarningSupressed`
  * TODO: Use isVerbose here (not only pass to `preparePipeline`)
  * TODO: [🪂] Use maxParallelCount here (not only pass to `preparePipeline`)
  * TODO: [♈] Probbably move expectations from templates to parameters

package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts

@@ -41,7 +41,7 @@ export type ExecutionReportJson = {
         /**
          * The prompt wich was executed
          */
-        readonly prompt: Omit<Prompt, 'pipelineUrl' | 'parameters'>;
+        readonly prompt: Omit<Prompt, 'pipelineUrl'>;
         /**
          * Result of the prompt execution (if not failed during LLM execution)
          */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/utils",
-    "version": "0.61.0-28",
+    "version": "0.61.0-30",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -1976,7 +1976,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.61.0-27';
+    var PROMPTBOOK_VERSION = '0.61.0-29';
     // TODO: !!!! List here all the versions and annotate + put into script
 
     // @promptbook/utils

package/umd/typings/src/execution/PipelineExecutor.d.ts

@@ -1,4 +1,5 @@
 import type { Promisable } from 'type-fest';
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 import { PipelineExecutionError } from '../errors/PipelineExecutionError';
 import type { TaskProgress } from '../types/TaskProgress';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
@@ -10,6 +11,8 @@ import type { PromptResultUsage } from './PromptResultUsage';
  *
  * It can be created with `createPipelineExecutor` function.
  *
+ * @@@ almost-JSON (what about errors)
+ *
  * @see https://github.com/webgptorg/promptbook#executor
  */
 export type PipelineExecutor = {
@@ -17,8 +20,16 @@ export type PipelineExecutor = {
 };
 /**
  * @@@
+ *
+ * @@@ almost-JSON (what about errors)
  */
 export type PipelineExecutorResult = {
+    /**
+     * Result parameters of the execution
+     *
+     * Note: If the execution was not successful, there are only some of the result parameters
+     */
+    readonly outputParameters: Parameters;
     /**
      * Whether the execution was successful, details are aviable in `executionReport`
      */
@@ -40,13 +51,14 @@ export type PipelineExecutorResult = {
      */
     readonly executionReport: ExecutionReportJson;
     /**
-     * Result parameters of the execution
+     * The prepared pipeline that was used for the execution
      *
-     * Note: If the execution was not successful, there are only some of the result parameters
+     * Note: If you called `createPipelineExecutor` with fully prepared pipeline, this is the same object as this pipeline
+     *       If you passed not fully prepared pipeline, this is same pipeline but fully prepared
      */
-    readonly outputParameters: Parameters;
+    readonly preparedPipeline: PipelineJson;
 };
 /**
  * TODO: [🧠] Should this file be in /execution or /types folder?
- * TODO: [💷] `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result
+ * TODO: [💷] `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result - BUT maybe NOT?
  */

package/umd/typings/src/execution/createPipelineExecutor.d.ts

@@ -20,6 +20,16 @@ type CreatePipelineExecutorSettings = {
      * @default false
      */
     readonly isVerbose?: boolean;
+    /**
+     * If you pass fully prepared pipeline, this does not matter
+     *
+     * Otherwise:
+     * If false or not set, warning is shown when pipeline is not prepared
+     * If true, warning is suppressed
+     *
+     * @default false
+     */
+    readonly isNotPreparedWarningSupressed?: boolean;
 };
 /**
  * Options for `createPipelineExecutor`
@@ -47,8 +57,6 @@ interface CreatePipelineExecutorOptions {
 export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
 export {};
 /**
- * TODO: !!!!! return `preparedPipeline` from execution
- * TODO: !!!!! `isNotPreparedWarningSupressed`
  * TODO: Use isVerbose here (not only pass to `preparePipeline`)
  * TODO: [🪂] Use maxParallelCount here (not only pass to `preparePipeline`)
  * TODO: [♈] Probbably move expectations from templates to parameters

package/umd/typings/src/types/execution-report/ExecutionReportJson.d.ts

@@ -41,7 +41,7 @@ export type ExecutionReportJson = {
         /**
          * The prompt wich was executed
          */
-        readonly prompt: Omit<Prompt, 'pipelineUrl' | 'parameters'>;
+        readonly prompt: Omit<Prompt, 'pipelineUrl'>;
         /**
          * Result of the prompt execution (if not failed during LLM execution)
          */