@promptbook/openai 0.110.0 → 0.111.0-0

package/README.md

@@ -27,6 +27,10 @@ Turn your company's scattered knowledge into AI ready Books
 
 
 
+<blockquote style="color: #ff8811">
+    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
+</blockquote>
+
 ## 📦 Package `@promptbook/openai`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).

package/esm/index.es.js

@@ -23,7 +23,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.110.0';
+const PROMPTBOOK_ENGINE_VERSION = '0.111.0-0';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -3480,6 +3480,44 @@ function mapToolsToOpenAi(tools) {
     }));
 }
 
+/**
+ * Prompt parameter key used to pass hidden runtime context to tool execution.
+ *
+ * @private internal runtime wiring for commitment tools
+ */
+const TOOL_RUNTIME_CONTEXT_PARAMETER = 'promptbookToolRuntimeContext';
+/**
+ * Hidden argument key used to pass runtime context into individual tool calls.
+ *
+ * @private internal runtime wiring for commitment tools
+ */
+const TOOL_RUNTIME_CONTEXT_ARGUMENT = '__promptbookToolRuntimeContext';
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */
+
+/**
+ * Builds a tool invocation script that injects hidden runtime context into tool args.
+ *
+ * @private utility of OpenAI tool execution wrappers
+ */
+function buildToolInvocationScript(options) {
+    const { functionName, functionArgsExpression } = options;
+    return `
+        const args = ${functionArgsExpression};
+        const runtimeContextRaw =
+            typeof ${TOOL_RUNTIME_CONTEXT_PARAMETER} === 'undefined'
+                ? undefined
+                : ${TOOL_RUNTIME_CONTEXT_PARAMETER};
+
+        if (runtimeContextRaw !== undefined && args && typeof args === 'object' && !Array.isArray(args)) {
+            args.${TOOL_RUNTIME_CONTEXT_ARGUMENT} = runtimeContextRaw;
+        }
+
+        return await ${functionName}(args);
+    `;
+}
+
 /**
  * Parses an OpenAI error message to identify which parameter is unsupported
  *
@@ -3833,10 +3871,10 @@ class OpenAiCompatibleExecutionTools {
                             const scriptTool = scriptTools[0]; // <- TODO: [🧠] Which script tool to use?
                             functionResponse = await scriptTool.execute({
                                 scriptLanguage: 'javascript',
-                                script: `
-                                    const args = ${functionArgs};
-                                    return await ${functionName}(args);
-                                `,
+                                script: buildToolInvocationScript({
+                                    functionName,
+                                    functionArgsExpression: functionArgs,
+                                }),
                                 parameters: prompt.parameters,
                             });
                         }
@@ -4521,23 +4559,11 @@ class OpenAiExecutionTools extends OpenAiCompatibleExecutionTools {
     }
 }
 
-/**
- * @@@
- *
- * @private thing of inline knowledge
- */
+/** @private The default base name for inline knowledge files when the content lacks identifying text */
 const INLINE_KNOWLEDGE_BASE_NAME = 'inline-knowledge';
-/**
- * @@@
- *
- * @private thing of inline knowledge
- */
+/** @private The default file extension used for inline knowledge uploads */
 const INLINE_KNOWLEDGE_EXTENSION = '.txt';
-/**
- * @@@
- *
- * @private thing of inline knowledge
- */
+/** @private Prefix that identifies base64 data URLs */
 const DATA_URL_PREFIX = 'data:';
 /**
  * Checks whether the provided source string is a data URL that can be decoded.
@@ -4550,7 +4576,7 @@ function isDataUrlKnowledgeSource(source) {
 /**
  * Parses a data URL-based knowledge source into its raw buffer, filename, and MIME type.
  *
- * @private thing of inline knowledge
+ * @private utility of inline knowledge processing
  */
 function parseDataUrlKnowledgeSource(source) {
     if (!isDataUrlKnowledgeSource(source)) {
@@ -5592,10 +5618,10 @@ class OpenAiAssistantExecutionTools extends OpenAiVectorStoreHandler {
                                 const scriptTool = scriptTools[0]; // <- TODO: [🧠] Which script tool to use?
                                 functionResponse = await scriptTool.execute({
                                     scriptLanguage: 'javascript',
-                                    script: `
-                                        const args = ${JSON.stringify(functionArgs)};
-                                        return await ${functionName}(args);
-                                    `,
+                                    script: buildToolInvocationScript({
+                                        functionName,
+                                        functionArgsExpression: JSON.stringify(functionArgs),
+                                    }),
                                     parameters: prompt.parameters,
                                 });
                                 if (this.options.isVerbose) {
@@ -6586,10 +6612,10 @@ class OpenAiAgentKitExecutionTools extends OpenAiVectorStoreHandler {
                         try {
                             return await scriptTool.execute({
                                 scriptLanguage: 'javascript',
-                                script: `
-                                        const args = ${JSON.stringify(functionArgs)};
-                                        return await ${functionName}(args);
-                                    `,
+                                script: buildToolInvocationScript({
+                                    functionName,
+                                    functionArgsExpression: JSON.stringify(functionArgs),
+                                }),
                                 parameters: (_c = (_b = runContext === null || runContext === void 0 ? void 0 : runContext.context) === null || _b === void 0 ? void 0 : _b.parameters) !== null && _c !== void 0 ? _c : {},
                             });
                         }