@promptbook/openai 0.52.0-6 → 0.52.0-8

package/README.md

@@ -42,7 +42,7 @@ import {
     createPromptbookLibraryFromDirectory,
     assertsExecutionSuccessful,
 } from '@promptbook/core';
-import { JavascriptEvalExecutionTools } from '@promptbook/execute-javascript';
+import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
 import { OpenAiExecutionTools } from '@promptbook/openai';
 
 // Create whole Promptbook library
@@ -56,7 +56,7 @@ const tools = {
     llm: new OpenAiExecutionTools({
         apiKey: process.env.OPENAI_API_KEY,
     }),
-    script: [new JavascriptEvalExecutionTools()],
+    script: [new JavascriptExecutionTools()],
 };
 
 // Create executor - the function that will execute the Promptbook

package/esm/typings/_packages/core.index.d.ts

@@ -9,6 +9,7 @@ import { CallbackInterfaceTools } from '../execution/plugins/user-interface-exec
 import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
+import { createPromptbookLibraryFromDirectory } from '../library/constructors/createPromptbookLibraryFromDirectory';
 import { createPromptbookLibraryFromPromise } from '../library/constructors/createPromptbookLibraryFromPromise';
 import { createPromptbookLibraryFromSources } from '../library/constructors/createPromptbookLibraryFromSources';
 import { createPromptbookSublibrary } from '../library/constructors/createPromptbookSublibrary';
@@ -19,7 +20,7 @@ import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
 export { ExecutionTypes, PROMPTBOOK_VERSION };
 export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prettifyPromptbookString, };
-export { createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, SimplePromptbookLibrary, };
+export { createPromptbookLibraryFromDirectory, createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };
 export { createPromptbookExecutor, MultipleLlmExecutionTools };

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

@@ -1,20 +1,7 @@
-import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
-import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptions';
+import { JavascriptEvalExecutionTools } from './JavascriptEvalExecutionTools';
 /**
- * ScriptExecutionTools for JavaScript implemented via vm2
+ * Placeholder for better implementation of JavascriptExecutionTools - some propper sandboxing
  *
- * Warning: This is not implemented yet
- */
-export declare class JavascriptExecutionTools implements ScriptExecutionTools {
-    private readonly options;
-    constructor(options?: JavascriptExecutionToolsOptions);
-    /**
-     * Executes a JavaScript
-     */
-    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
-}
-/**
- * TODO: !! Pass isVerbose to constructor and use it
- * TODO: !! Probbably make some common util createStatementToEvaluate
- * TODO: !! Implement via vm2
+ * @alias JavascriptExecutionTools
  */
+export declare const JavascriptExecutionTools: typeof JavascriptEvalExecutionTools;

package/esm/typings/library/constructors/createPromptbookLibraryFromDirectory.d.ts

@@ -1,4 +1,16 @@
+import { string_folder_path } from '../../types/typeAliases';
 import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * Options for `createPromptbookLibraryFromDirectory` function
+ */
+type CreatePromptbookLibraryFromDirectoryOptions = {
+    /**
+     * If true, the directory is searched recursively for promptbooks
+     *
+     * @default true
+     */
+    isRecursive?: boolean;
+};
 /**
  * Constructs Promptbook from given directory
  *
@@ -6,9 +18,12 @@ import { PromptbookLibrary } from '../PromptbookLibrary';
  * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
  *       SO during the construction syntax and logic sources IS NOT validated
  *
+ * @param path - path to the directory with promptbooks
+ * @param options - Misc options for the library
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromDirectory(): PromptbookLibrary;
+export declare function createPromptbookLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): PromptbookLibrary;
+export {};
 /***
  * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

package/package.json

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

package/umd/typings/_packages/core.index.d.ts

@@ -9,6 +9,7 @@ import { CallbackInterfaceTools } from '../execution/plugins/user-interface-exec
 import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
+import { createPromptbookLibraryFromDirectory } from '../library/constructors/createPromptbookLibraryFromDirectory';
 import { createPromptbookLibraryFromPromise } from '../library/constructors/createPromptbookLibraryFromPromise';
 import { createPromptbookLibraryFromSources } from '../library/constructors/createPromptbookLibraryFromSources';
 import { createPromptbookSublibrary } from '../library/constructors/createPromptbookSublibrary';
@@ -19,7 +20,7 @@ import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
 export { ExecutionTypes, PROMPTBOOK_VERSION };
 export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prettifyPromptbookString, };
-export { createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, SimplePromptbookLibrary, };
+export { createPromptbookLibraryFromDirectory, createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };
 export { createPromptbookExecutor, MultipleLlmExecutionTools };

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

@@ -1,20 +1,7 @@
-import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
-import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptions';
+import { JavascriptEvalExecutionTools } from './JavascriptEvalExecutionTools';
 /**
- * ScriptExecutionTools for JavaScript implemented via vm2
+ * Placeholder for better implementation of JavascriptExecutionTools - some propper sandboxing
  *
- * Warning: This is not implemented yet
- */
-export declare class JavascriptExecutionTools implements ScriptExecutionTools {
-    private readonly options;
-    constructor(options?: JavascriptExecutionToolsOptions);
-    /**
-     * Executes a JavaScript
-     */
-    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
-}
-/**
- * TODO: !! Pass isVerbose to constructor and use it
- * TODO: !! Probbably make some common util createStatementToEvaluate
- * TODO: !! Implement via vm2
+ * @alias JavascriptExecutionTools
  */
+export declare const JavascriptExecutionTools: typeof JavascriptEvalExecutionTools;

package/umd/typings/library/constructors/createPromptbookLibraryFromDirectory.d.ts

@@ -1,4 +1,16 @@
+import { string_folder_path } from '../../types/typeAliases';
 import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * Options for `createPromptbookLibraryFromDirectory` function
+ */
+type CreatePromptbookLibraryFromDirectoryOptions = {
+    /**
+     * If true, the directory is searched recursively for promptbooks
+     *
+     * @default true
+     */
+    isRecursive?: boolean;
+};
 /**
  * Constructs Promptbook from given directory
  *
@@ -6,9 +18,12 @@ import { PromptbookLibrary } from '../PromptbookLibrary';
  * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
  *       SO during the construction syntax and logic sources IS NOT validated
  *
+ * @param path - path to the directory with promptbooks
+ * @param options - Misc options for the library
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromDirectory(): PromptbookLibrary;
+export declare function createPromptbookLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): PromptbookLibrary;
+export {};
 /***
  * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */