@promptbook/node 0.86.30 → 0.88.0-1

package/esm/typings/src/_packages/{execute-javascript.index.d.ts → javascript.index.d.ts}

@@ -2,7 +2,9 @@ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { JavascriptEvalExecutionTools } from '../scripting/javascript/JavascriptEvalExecutionTools';
 import { JavascriptExecutionTools } from '../scripting/javascript/JavascriptExecutionTools';
 import { POSTPROCESSING_FUNCTIONS } from '../scripting/javascript/postprocessing-functions';
+import { extractVariablesFromJavascript } from '../scripting/javascript/utils/extractVariablesFromJavascript';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { JavascriptEvalExecutionTools };
 export { JavascriptExecutionTools };
 export { POSTPROCESSING_FUNCTIONS };
+export { extractVariablesFromJavascript };

package/esm/typings/src/_packages/node.index.d.ts

@@ -6,6 +6,7 @@ import { $provideLlmToolsConfigurationFromEnv } from '../llm-providers/_common/r
 import { $provideLlmToolsFromEnv } from '../llm-providers/_common/register/$provideLlmToolsFromEnv';
 import { $provideFilesystemForNode } from '../scrapers/_common/register/$provideFilesystemForNode';
 import { $provideScrapersForNode } from '../scrapers/_common/register/$provideScrapersForNode';
+import { $provideScriptingForNode } from '../scrapers/_common/register/$provideScriptingForNode';
 import { FileCacheStorage } from '../storage/file-cache-storage/FileCacheStorage';
 import { $execCommand } from '../utils/execCommand/$execCommand';
 import { $execCommands } from '../utils/execCommand/$execCommands';
@@ -17,6 +18,7 @@ export { $provideLlmToolsConfigurationFromEnv };
 export { $provideLlmToolsFromEnv };
 export { $provideFilesystemForNode };
 export { $provideScrapersForNode };
+export { $provideScriptingForNode };
 export { FileCacheStorage };
 export { $execCommand };
 export { $execCommands };

package/esm/typings/src/scrapers/_common/register/$provideScriptingForNode.d.ts

@@ -0,0 +1,11 @@
+import type { ScriptExecutionTools } from '../../../execution/ScriptExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+/**
+ * Provides script execution tools
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $provideScriptingForNode(options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<ScriptExecutionTools>>;
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts

@@ -6,7 +6,7 @@ import type { JavascriptExecutionToolsOptions } from './JavascriptExecutionTools
  * Warning: It is used for testing and mocking
  *          **NOT intended to use in the production** due to its unsafe nature, use `JavascriptExecutionTools` instead.
  *
- * @public exported from `@promptbook/execute-javascript`
+ * @public exported from `@promptbook/javascript`
  */
 export declare class JavascriptEvalExecutionTools implements ScriptExecutionTools {
     protected readonly options: JavascriptExecutionToolsOptions;

package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: Make shared test between JavascriptEvalExecutionTools and JavascriptExecutionTools to test the same functionality when implemented via vm2
+ */

package/esm/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts

@@ -3,6 +3,6 @@ import { JavascriptEvalExecutionTools } from './JavascriptEvalExecutionTools';
  * Placeholder for better implementation of JavascriptExecutionTools - some propper sandboxing
  *
  * @alias JavascriptExecutionTools
- * @public exported from `@promptbook/execute-javascript`
+ * @public exported from `@promptbook/javascript`
  */
 export declare const JavascriptExecutionTools: typeof JavascriptEvalExecutionTools;

package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts

@@ -20,7 +20,7 @@ import { unwrapResult } from '../../utils/unwrapResult';
 /**
  * @@@
  *
- * @public exported from `@promptbook/execute-javascript`
+ * @public exported from `@promptbook/javascript`
  */
 export declare const POSTPROCESSING_FUNCTIONS: {
     spaceTrim: typeof spaceTrim;

package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.d.ts

@@ -0,0 +1,14 @@
+import type { string_javascript } from '../../../types/typeAliases';
+import type { string_javascript_name } from '../../../types/typeAliases';
+/**
+ * Parses the given script and returns the list of all used variables that are not defined in the script
+ *
+ * @param script from which to extract the variables
+ * @returns the list of variable names
+ * @throws {ParseError} if the script is invalid
+ * @public exported from `@promptbook/javascript`
+ */
+export declare function extractVariablesFromJavascript(script: string_javascript): Set<string_javascript_name>;
+/**
+ * TODO: [🔣] Support for multiple languages - python, java,...
+ */

package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.test.d.ts

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

package/esm/typings/src/scripting/javascript/utils/extractVariablesFromScript.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/node",
-    "version": "0.86.30",
+    "version": "0.88.0-1",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -47,7 +47,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/node.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.86.30"
+        "@promptbook/core": "0.88.0-1"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -46,7 +46,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.86.30';
+    const PROMPTBOOK_ENGINE_VERSION = '0.88.0-1';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2132,6 +2132,83 @@
         }, deepClone(ZERO_USAGE));
     }
 
+    /**
+     * Parses the given script and returns the list of all used variables that are not defined in the script
+     *
+     * @param script from which to extract the variables
+     * @returns the list of variable names
+     * @throws {ParseError} if the script is invalid
+     * @public exported from `@promptbook/javascript`
+     */
+    function extractVariablesFromJavascript(script) {
+        const variables = new Set();
+        const originalScript = script;
+        script = `(()=>{${script}})()`;
+        try {
+            for (let i = 0; i < LOOP_LIMIT; i++)
+                try {
+                    eval(script); // <- TODO: Use `JavascriptExecutionTools.execute` here
+                }
+                catch (error) {
+                    if (!(error instanceof ReferenceError)) {
+                        throw error;
+                    }
+                    /*
+                    Note: Parsing the error
+                          🌟 Most devices:
+                          [PipelineUrlError: thing is not defined]
+
+                          🍏 iPhone`s Safari:
+                          [PipelineUrlError: Can't find variable: thing]
+                    */
+                    let variableName = undefined;
+                    if (error.message.startsWith(`Can't`)) {
+                        // 🍏 Case
+                        variableName = error.message.split(' ').pop();
+                    }
+                    else {
+                        // 🌟 Case
+                        variableName = error.message.split(' ').shift();
+                    }
+                    if (variableName === undefined) {
+                        throw error;
+                    }
+                    if (script.includes(variableName + '(')) {
+                        script = `const ${variableName} = ()=>'';` + script;
+                    }
+                    else {
+                        variables.add(variableName);
+                        script = `const ${variableName} = '';` + script;
+                    }
+                }
+        }
+        catch (error) {
+            if (!(error instanceof Error)) {
+                throw error;
+            }
+            throw new ParseError(spaceTrim.spaceTrim((block) => `
+                    Can not extract variables from the script
+                    ${block(error.stack || error.message)}
+
+                    Found variables:
+                    ${Array.from(variables)
+            .map((variableName, i) => `${i + 1}) ${variableName}`)
+            .join('\n')}
+
+
+                    The script:
+
+                    \`\`\`javascript
+                    ${block(originalScript)}
+                    \`\`\`
+                `));
+        }
+        return variables;
+    }
+    /**
+     * TODO: [🔣] Support for multiple languages - python, java,...
+     */
+
     /**
      * Parses the task and returns the set of all used parameters
      *
@@ -2141,24 +2218,26 @@
      * @public exported from `@promptbook/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
      */
     function extractParameterNamesFromTask(task) {
-        const { title, description, /* [🙊] taskType,*/ content, preparedContent, jokerParameterNames, foreach } = task;
+        const { title, description, taskType, content, preparedContent, jokerParameterNames, foreach } = task;
         const parameterNames = new Set();
+        let contentParameters;
+        if (taskType !== 'SCRIPT_TASK') {
+            contentParameters = extractParameterNames(content);
+        }
+        else {
+            // TODO: What if script is not javascript?
+            // const { contentLanguage } = task;
+            // if (contentLanguage !== 'javascript') {
+            contentParameters = extractVariablesFromJavascript(content);
+        }
         for (const parameterName of [
             ...extractParameterNames(title),
             ...extractParameterNames(description || ''),
-            ...extractParameterNames(content),
+            ...contentParameters,
             ...extractParameterNames(preparedContent || ''),
         ]) {
             parameterNames.add(parameterName);
         }
-        /*/
-        // TODO: [🙊] Fix `extractVariablesFromScript` or delete
-        if (taskType === 'SCRIPT_TASK') {
-            for (const parameterName of extractVariablesFromScript(content)) {
-                parameterNames.add(parameterName);
-            }
-        }
-        /**/
         for (const jokerName of jokerParameterNames || []) {
             parameterNames.add(jokerName);
         }
@@ -9842,7 +9921,7 @@
      * Warning: It is used for testing and mocking
      *          **NOT intended to use in the production** due to its unsafe nature, use `JavascriptExecutionTools` instead.
      *
-     * @public exported from `@promptbook/execute-javascript`
+     * @public exported from `@promptbook/javascript`
      */
     class JavascriptEvalExecutionTools {
         constructor(options) {
@@ -9948,8 +10027,8 @@
             // Note: Custom functions are exposed to the current scope as variables
             `const ${functionName} = customFunctions.${functionName};`)
                 .join('\n');
-            script = templateParameters(script, parameters);
-            // <- Note: [🙊]
+            // script = templateParameters(script, parameters);
+            // <- TODO: [🧠][🥳] Should be this is one of two variants how to use parameters in script
             const statementToEvaluate = spaceTrim__default["default"]((block) => `
 
                 // Build-in functions:
@@ -10040,7 +10119,7 @@
      * Placeholder for better implementation of JavascriptExecutionTools - some propper sandboxing
      *
      * @alias JavascriptExecutionTools
-     * @public exported from `@promptbook/execute-javascript`
+     * @public exported from `@promptbook/javascript`
      */
     const JavascriptExecutionTools = JavascriptEvalExecutionTools;
 
@@ -10383,6 +10462,22 @@
      * TODO: Maybe move from `@promptbook/node` to `@promptbook/core` as we removes direct dependency on `fs`
      */
 
+    /**
+     * Provides script execution tools
+     *
+     * @public exported from `@promptbook/node`
+     */
+    async function $provideScriptingForNode(options) {
+        if (!$isRunningInNode()) {
+            throw new EnvironmentMismatchError('Function `$provideScriptingForNode` works only in Node.js environment');
+        }
+        // TODO: [🔱] Do here auto-installation
+        return [new JavascriptExecutionTools(options)];
+    }
+    /**
+     * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+     */
+
     /**
      * Stringify the PipelineJson with proper formatting
      *
@@ -10509,6 +10604,7 @@
     exports.$provideLlmToolsConfigurationFromEnv = $provideLlmToolsConfigurationFromEnv;
     exports.$provideLlmToolsFromEnv = $provideLlmToolsFromEnv;
     exports.$provideScrapersForNode = $provideScrapersForNode;
+    exports.$provideScriptingForNode = $provideScriptingForNode;
     exports.BOOK_LANGUAGE_VERSION = BOOK_LANGUAGE_VERSION;
     exports.FileCacheStorage = FileCacheStorage;
     exports.PROMPTBOOK_ENGINE_VERSION = PROMPTBOOK_ENGINE_VERSION;