@promptbook/openai 0.28.0 → 0.29.0-1

package/esm/typings/execution/CommonExecutionToolsOptions.d.ts

@@ -4,3 +4,6 @@ export interface CommonExecutionToolsOptions {
      */
     readonly isVerbose?: boolean;
 }
+/**
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ */

package/esm/typings/execution/ScriptExecutionTools.d.ts

@@ -32,3 +32,6 @@ export interface ScriptExecutionToolsExecuteOptions {
      */
     script: string_script;
 }
+/**
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ */ 

package/esm/typings/execution/plugins/script-execution-tools/custom-function-missing.test.d.ts

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

package/esm/typings/execution/plugins/script-execution-tools/custom-function-with-dependencies.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: !!!! custom-function-async.test.ts
+ */

package/esm/typings/execution/plugins/script-execution-tools/custom-function.test.d.ts

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

package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.d.ts

@@ -1,5 +1,5 @@
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
 import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
+import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptions';
 /**
  * ScriptExecutionTools for JavaScript implemented via eval
  *
@@ -8,7 +8,7 @@ import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../
  */
 export declare class JavascriptEvalExecutionTools implements ScriptExecutionTools {
     private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
+    constructor(options: JavascriptExecutionToolsOptions);
     /**
      * Executes a JavaScript
      */
@@ -16,4 +16,5 @@ export declare class JavascriptEvalExecutionTools implements ScriptExecutionTool
 }
 /**
  * TODO: Put predefined functions (like removeQuotes, spaceTrim, etc.) into annotation OR pass into constructor
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
  */

package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools.d.ts

@@ -1,5 +1,5 @@
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
 import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
+import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptions';
 /**
  * ScriptExecutionTools for JavaScript implemented via vm2
  *
@@ -7,7 +7,7 @@ import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../
  */
 export declare class JavascriptExecutionTools implements ScriptExecutionTools {
     private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
+    constructor(options: JavascriptExecutionToolsOptions);
     /**
      * Executes a JavaScript
      */

package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionToolsOptions.d.ts

@@ -0,0 +1,22 @@
+import type { Promisable } from 'type-fest';
+import type { string_javascript_name } from '../../../../types/typeAliases';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+/**
+ * Options for javascript execution
+ */
+export type JavascriptExecutionToolsOptions = CommonExecutionToolsOptions & {
+    /**
+     * Functions to be executed in the JavaScript evaluation.
+     *
+     * This can be used in two ways:
+     * 1. To provide custom postprocessing functions. For this case function must receive one string and return a (promise of) string.
+     * 2. As environment for the ECECUTE SCRIPT, For this case function can be any function. [0]
+     *
+     * Note: There are also some built-in functions available:
+     *      @see ./JavascriptEvalExecutionTools.ts
+     */
+    functions?: Record<string_javascript_name, (value: string) => Promisable<string> | Function>;
+};
+/**
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ */

package/esm/typings/execution/plugins/script-execution-tools/postprocessing.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: What is the ideal folder for this test?
- */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.28.0",
+    "version": "0.29.0-1",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -37,7 +37,7 @@
         "openai": "4.2.0"
     },
     "peerDependencies": {
-        "@promptbook/core": "0.28.0"
+        "@promptbook/core": "0.29.0-1"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/typings/execution/CommonExecutionToolsOptions.d.ts

@@ -4,3 +4,6 @@ export interface CommonExecutionToolsOptions {
      */
     readonly isVerbose?: boolean;
 }
+/**
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ */

package/umd/typings/execution/ScriptExecutionTools.d.ts

@@ -32,3 +32,6 @@ export interface ScriptExecutionToolsExecuteOptions {
      */
     script: string_script;
 }
+/**
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ */ 

package/umd/typings/execution/plugins/script-execution-tools/custom-function-missing.test.d.ts

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

package/umd/typings/execution/plugins/script-execution-tools/custom-function-with-dependencies.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: !!!! custom-function-async.test.ts
+ */

package/umd/typings/execution/plugins/script-execution-tools/custom-function.test.d.ts

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

package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.d.ts

@@ -1,5 +1,5 @@
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
 import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
+import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptions';
 /**
  * ScriptExecutionTools for JavaScript implemented via eval
  *
@@ -8,7 +8,7 @@ import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../
  */
 export declare class JavascriptEvalExecutionTools implements ScriptExecutionTools {
     private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
+    constructor(options: JavascriptExecutionToolsOptions);
     /**
      * Executes a JavaScript
      */
@@ -16,4 +16,5 @@ export declare class JavascriptEvalExecutionTools implements ScriptExecutionTool
 }
 /**
  * TODO: Put predefined functions (like removeQuotes, spaceTrim, etc.) into annotation OR pass into constructor
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
  */

package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools.d.ts

@@ -1,5 +1,5 @@
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
 import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
+import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptions';
 /**
  * ScriptExecutionTools for JavaScript implemented via vm2
  *
@@ -7,7 +7,7 @@ import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../
  */
 export declare class JavascriptExecutionTools implements ScriptExecutionTools {
     private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
+    constructor(options: JavascriptExecutionToolsOptions);
     /**
      * Executes a JavaScript
      */

package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionToolsOptions.d.ts

@@ -0,0 +1,22 @@
+import type { Promisable } from 'type-fest';
+import type { string_javascript_name } from '../../../../types/typeAliases';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+/**
+ * Options for javascript execution
+ */
+export type JavascriptExecutionToolsOptions = CommonExecutionToolsOptions & {
+    /**
+     * Functions to be executed in the JavaScript evaluation.
+     *
+     * This can be used in two ways:
+     * 1. To provide custom postprocessing functions. For this case function must receive one string and return a (promise of) string.
+     * 2. As environment for the ECECUTE SCRIPT, For this case function can be any function. [0]
+     *
+     * Note: There are also some built-in functions available:
+     *      @see ./JavascriptEvalExecutionTools.ts
+     */
+    functions?: Record<string_javascript_name, (value: string) => Promisable<string> | Function>;
+};
+/**
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ */

package/umd/typings/execution/plugins/script-execution-tools/postprocessing.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: What is the ideal folder for this test?
- */