@promptbook/remote-client - npm Package Compare versions

Comparing version 0.61.0-28 to 0.61.0-29

esm/index.es.js

@@ -217,3 +217,3 @@ import { io } from 'socket.io-client';
  */
-var PROMPTBOOK_VERSION = '0.61.0-27';
+var PROMPTBOOK_VERSION = '0.61.0-28';
 // TODO: !!!! List here all the versions and annotate + put into script
@@ -220,0 +220,0 @@

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

@@ -23,2 +23,12 @@ import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
     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;
 };
@@ -51,4 +61,2 @@ /**
 /**
- * TODO: !!!!! return `preparedPipeline` from execution
- * TODO: !!!!! `isNotPreparedWarningSupressed`
  * TODO: Use isVerbose here (not only pass to `preparePipeline`)
@@ -55,0 +63,0 @@ * TODO: [🪂] Use maxParallelCount here (not only pass to `preparePipeline`)

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

 import type { Promisable } from 'type-fest';
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 import { PipelineExecutionError } from '../errors/PipelineExecutionError';
@@ -13,2 +14,4 @@ import type { TaskProgress } from '../types/TaskProgress';
  *
+ * @@@ almost-JSON (what about errors)
+ *
  * @see https://github.com/webgptorg/promptbook#executor
@@ -21,5 +24,13 @@ */
  * @@@
+ *
+ * @@@ 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`
@@ -45,11 +56,12 @@ */
     /**
-     * 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?
  */

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

@@ -44,3 +44,3 @@ import type { PromptResult } from '../../execution/PromptResult';
          */
-        readonly prompt: Omit<Prompt, 'pipelineUrl' | 'parameters'>;
+        readonly prompt: Omit<Prompt, 'pipelineUrl'>;
         /**
@@ -47,0 +47,0 @@ * Result of the prompt execution (if not failed during LLM execution)

package.json

 {
     "name": "@promptbook/remote-client",
-    "version": "0.61.0-28",
+    "version": "0.61.0-29",
     "description": "Supercharge your use of large language models",
@@ -50,3 +50,3 @@ "private": false,
     "peerDependencies": {
-        "@promptbook/core": "0.61.0-28"
+        "@promptbook/core": "0.61.0-29"
     },
@@ -53,0 +53,0 @@ "main": "./umd/index.umd.js",

umd/index.umd.js

@@ -221,3 +221,3 @@ (function (global, factory) {
      */
-    var PROMPTBOOK_VERSION = '0.61.0-27';
+    var PROMPTBOOK_VERSION = '0.61.0-28';
     // TODO: !!!! List here all the versions and annotate + put into script
@@ -224,0 +224,0 @@

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

@@ -23,2 +23,12 @@ import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
     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;
 };
@@ -51,4 +61,2 @@ /**
 /**
- * TODO: !!!!! return `preparedPipeline` from execution
- * TODO: !!!!! `isNotPreparedWarningSupressed`
  * TODO: Use isVerbose here (not only pass to `preparePipeline`)
@@ -55,0 +63,0 @@ * TODO: [🪂] Use maxParallelCount here (not only pass to `preparePipeline`)

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

 import type { Promisable } from 'type-fest';
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 import { PipelineExecutionError } from '../errors/PipelineExecutionError';
@@ -13,2 +14,4 @@ import type { TaskProgress } from '../types/TaskProgress';
  *
+ * @@@ almost-JSON (what about errors)
+ *
  * @see https://github.com/webgptorg/promptbook#executor
@@ -21,5 +24,13 @@ */
  * @@@
+ *
+ * @@@ 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`
@@ -45,11 +56,12 @@ */
     /**
-     * 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?
  */

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

@@ -44,3 +44,3 @@ import type { PromptResult } from '../../execution/PromptResult';
          */
-        readonly prompt: Omit<Prompt, 'pipelineUrl' | 'parameters'>;
+        readonly prompt: Omit<Prompt, 'pipelineUrl'>;
         /**
@@ -47,0 +47,0 @@ * Result of the prompt execution (if not failed during LLM execution)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

671379

increased by0.21%

Lines of code

13245

increased by0.3%

No dependency changes