@promptbook/remote-client 0.86.22 → 0.86.31

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-client",
-    "version": "0.86.22",
+    "version": "0.86.31",
     "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/remote-client.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.86.22"
+        "@promptbook/core": "0.86.31"
     },
     "dependencies": {
         "crypto-js": "4.2.0",

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.86.22';
+    const PROMPTBOOK_ENGINE_VERSION = '0.86.31';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -294,6 +294,13 @@
      * @public exported from `@promptbook/core`
      */
     const DEFAULT_BOOK_OUTPUT_PARAMETER_NAME = 'result';
+    // <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
+    /**
+     * The maximum number of iterations for a loops
+     *
+     * @private within the repository - too low-level in comparison with other `MAX_...`
+     */
+    const LOOP_LIMIT = 1000;
     /**
      * Timeout for the connections in milliseconds
      *
@@ -4735,136 +4742,60 @@
     }
 
     /**
-     * Parses the task and returns the list of all parameter names
+     * Parses the given script and returns the list of all used variables that are not defined in the script
      *
-     * @param template the string template with parameters in {curly} braces
-     * @returns the list of parameter names
-     * @public exported from `@promptbook/utils`
-     */
-    function extractParameterNames(template) {
-        const matches = template.matchAll(/{\w+}/g);
-        const parameterNames = new Set();
-        for (const match of matches) {
-            const parameterName = match[0].slice(1, -1);
-            parameterNames.add(parameterName);
-        }
-        return parameterNames;
-    }
-
-    /**
-     * Extract all used variable names from ginen JavaScript/TypeScript script
-     *
-     * @param script JavaScript/TypeScript script
-     * @returns Set of variable names
+     * @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/utils` <- Note: [👖] This is usable elsewhere than in Promptbook, so keeping in utils
+     * @public exported from `@promptbook/execute-javascript`
      */
-    function extractVariablesFromScript(script) {
-        if (script.trim() === '') {
-            return new Set();
-        }
+    function extractVariablesFromJavascript(script) {
         const variables = new Set();
-        // JS keywords and builtins to exclude
-        const exclude = new Set([
-            // Keywords
-            'break',
-            'case',
-            'catch',
-            'class',
-            'const',
-            'continue',
-            'debugger',
-            'default',
-            'delete',
-            'do',
-            'else',
-            'export',
-            'extends',
-            'false',
-            'finally',
-            'for',
-            'function',
-            'if',
-            'import',
-            'in',
-            'instanceof',
-            'let',
-            'new',
-            'null',
-            'return',
-            'super',
-            'switch',
-            'this',
-            'throw',
-            'true',
-            'try',
-            'typeof',
-            'var',
-            'void',
-            'while',
-            'with',
-            'yield',
-            // Common globals
-            'console',
-            'JSON',
-            'Error',
-            // Typescript types
-            'string',
-            'number',
-            'boolean',
-            'object',
-            'symbol',
-            // Common methods on built-in objects
-            'test',
-            'match',
-            'exec',
-            'replace',
-            'search',
-            'split',
-        ]);
+        const originalScript = script;
+        script = `(()=>{${script}})()`;
         try {
-            // Note: Extract variables from template literals like ${variable}
-            const templateRegex = /\$\{([a-zA-Z_$][a-zA-Z0-9_$]*)\}/g;
-            let match;
-            while ((match = templateRegex.exec(script)) !== null) {
-                const varName = match[1];
-                if (!exclude.has(varName)) {
-                    variables.add(varName);
+            for (let i = 0; i < LOOP_LIMIT; i++)
+                try {
+                    eval(script); // <- TODO: Use `JavascriptExecutionTools.execute` here
                 }
-            }
-            // Note: Process the script to handle normal variable usage
-            const processedScript = script
-                .replace(/'(?:\\.|[^'\\])*'/g, "''") // <- Note: Remove string literals
-                .replace(/"(?:\\.|[^"\\])*"/g, '""')
-                .replace(/`(?:\\.|[^`\\])*`/g, '``')
-                .replace(/\/(?:\\.|[^/\\])*\/[gimsuy]*/g, '{}'); // <- Note: Remove regex literals
-            // Note: Find identifiers in function arguments
-            const funcArgRegex = /\b([a-zA-Z_$][a-zA-Z0-9_$]*)\s*\(/g;
-            const funcNames = new Set();
-            while ((match = funcArgRegex.exec(processedScript)) !== null) {
-                funcNames.add(match[1]);
-            }
-            // Find variable declarations to exclude them
-            const declaredVars = new Set();
-            const declRegex = /\b(const|let|var)\s+([a-zA-Z_$][a-zA-Z0-9_$]*)\b/g;
-            while ((match = declRegex.exec(processedScript)) !== null) {
-                declaredVars.add(match[2]);
-            }
-            // Note: Find identifiers in the script
-            const identifierRegex = /\b([a-zA-Z_$][a-zA-Z0-9_$]*)\b/g;
-            while ((match = identifierRegex.exec(processedScript)) !== null) {
-                const name = match[1];
-                // Add if not excluded, not a function name, and not a declared variable
-                if (!exclude.has(name) && !funcNames.has(name) && !declaredVars.has(name)) {
-                    variables.add(name);
+                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__default["default"]((block) => `
+            throw new ParseError(spaceTrim.spaceTrim((block) => `
                     Can not extract variables from the script
                     ${block(error.stack || error.message)}
 
@@ -4877,7 +4808,7 @@
                     The script:
 
                     \`\`\`javascript
-                    ${block(script)}
+                    ${block(originalScript)}
                     \`\`\`
                 `));
         }
@@ -4887,6 +4818,23 @@
      * TODO: [🔣] Support for multiple languages - python, java,...
      */
 
+    /**
+     * Parses the task and returns the list of all parameter names
+     *
+     * @param template the string template with parameters in {curly} braces
+     * @returns the list of parameter names
+     * @public exported from `@promptbook/utils`
+     */
+    function extractParameterNames(template) {
+        const matches = template.matchAll(/{\w+}/g);
+        const parameterNames = new Set();
+        for (const match of matches) {
+            const parameterName = match[0].slice(1, -1);
+            parameterNames.add(parameterName);
+        }
+        return parameterNames;
+    }
+
     /**
      * Parses the task and returns the set of all used parameters
      *
@@ -4898,19 +4846,24 @@
     function extractParameterNamesFromTask(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);
         }
-        if (taskType === 'SCRIPT_TASK') {
-            for (const parameterName of extractVariablesFromScript(content)) {
-                parameterNames.add(parameterName);
-            }
-        }
         for (const jokerName of jokerParameterNames || []) {
             parameterNames.add(jokerName);
         }