@promptbook/node 0.86.30 → 0.88.0-1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -3
- package/esm/index.es.js +111 -16
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/{execute-javascript.index.d.ts → javascript.index.d.ts} +2 -0
- package/esm/typings/src/_packages/node.index.d.ts +2 -0
- package/esm/typings/src/scrapers/_common/register/$provideScriptingForNode.d.ts +11 -0
- package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +1 -1
- package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -0
- package/esm/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts +1 -1
- package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts +1 -1
- package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.d.ts +14 -0
- package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.test.d.ts +1 -0
- package/esm/typings/src/scripting/javascript/utils/extractVariablesFromScript.test.d.ts +1 -0
- package/package.json +2 -2
- package/umd/index.umd.js +111 -15
- package/umd/index.umd.js.map +1 -1
package/README.md
CHANGED
|
@@ -23,6 +23,10 @@
|
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
26
|
+
<blockquote style="color: #ff8811">
|
|
27
|
+
<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>.
|
|
28
|
+
</blockquote>
|
|
29
|
+
|
|
26
30
|
## 📦 Package `@promptbook/node`
|
|
27
31
|
|
|
28
32
|
- Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
|
|
@@ -253,7 +257,7 @@ Or you can install them separately:
|
|
|
253
257
|
- ⭐ **[@promptbook/utils](https://www.npmjs.com/package/@promptbook/utils)** - Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
|
|
254
258
|
- **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown
|
|
255
259
|
- _(Not finished)_ **[@promptbook/wizzard](https://www.npmjs.com/package/@promptbook/wizzard)** - Wizard for creating+running promptbooks in single line
|
|
256
|
-
- **[@promptbook/
|
|
260
|
+
- **[@promptbook/javascript](https://www.npmjs.com/package/@promptbook/javascript)** - Execution tools for javascript inside promptbooks
|
|
257
261
|
- **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
|
|
258
262
|
- **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
|
|
259
263
|
- **[@promptbook/vercel](https://www.npmjs.com/package/@promptbook/vercel)** - Adapter for Vercel functionalities
|
|
@@ -409,8 +413,6 @@ Promptbook project is under [BUSL 1.1 is an SPDX license](https://spdx.org/licen
|
|
|
409
413
|
|
|
410
414
|
See [TODO.md](./TODO.md)
|
|
411
415
|
|
|
412
|
-
|
|
413
|
-
|
|
414
416
|
## 🤝 Partners
|
|
415
417
|
|
|
416
418
|
<div style="display: flex; align-items: center; gap: 20px;">
|
package/esm/index.es.js
CHANGED
|
@@ -30,7 +30,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
|
|
|
30
30
|
* @generated
|
|
31
31
|
* @see https://github.com/webgptorg/promptbook
|
|
32
32
|
*/
|
|
33
|
-
const PROMPTBOOK_ENGINE_VERSION = '0.
|
|
33
|
+
const PROMPTBOOK_ENGINE_VERSION = '0.88.0-1';
|
|
34
34
|
/**
|
|
35
35
|
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
|
36
36
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
@@ -2116,6 +2116,83 @@ function addUsage(...usageItems) {
|
|
|
2116
2116
|
}, deepClone(ZERO_USAGE));
|
|
2117
2117
|
}
|
|
2118
2118
|
|
|
2119
|
+
/**
|
|
2120
|
+
* Parses the given script and returns the list of all used variables that are not defined in the script
|
|
2121
|
+
*
|
|
2122
|
+
* @param script from which to extract the variables
|
|
2123
|
+
* @returns the list of variable names
|
|
2124
|
+
* @throws {ParseError} if the script is invalid
|
|
2125
|
+
* @public exported from `@promptbook/javascript`
|
|
2126
|
+
*/
|
|
2127
|
+
function extractVariablesFromJavascript(script) {
|
|
2128
|
+
const variables = new Set();
|
|
2129
|
+
const originalScript = script;
|
|
2130
|
+
script = `(()=>{${script}})()`;
|
|
2131
|
+
try {
|
|
2132
|
+
for (let i = 0; i < LOOP_LIMIT; i++)
|
|
2133
|
+
try {
|
|
2134
|
+
eval(script); // <- TODO: Use `JavascriptExecutionTools.execute` here
|
|
2135
|
+
}
|
|
2136
|
+
catch (error) {
|
|
2137
|
+
if (!(error instanceof ReferenceError)) {
|
|
2138
|
+
throw error;
|
|
2139
|
+
}
|
|
2140
|
+
/*
|
|
2141
|
+
Note: Parsing the error
|
|
2142
|
+
🌟 Most devices:
|
|
2143
|
+
[PipelineUrlError: thing is not defined]
|
|
2144
|
+
|
|
2145
|
+
🍏 iPhone`s Safari:
|
|
2146
|
+
[PipelineUrlError: Can't find variable: thing]
|
|
2147
|
+
*/
|
|
2148
|
+
let variableName = undefined;
|
|
2149
|
+
if (error.message.startsWith(`Can't`)) {
|
|
2150
|
+
// 🍏 Case
|
|
2151
|
+
variableName = error.message.split(' ').pop();
|
|
2152
|
+
}
|
|
2153
|
+
else {
|
|
2154
|
+
// 🌟 Case
|
|
2155
|
+
variableName = error.message.split(' ').shift();
|
|
2156
|
+
}
|
|
2157
|
+
if (variableName === undefined) {
|
|
2158
|
+
throw error;
|
|
2159
|
+
}
|
|
2160
|
+
if (script.includes(variableName + '(')) {
|
|
2161
|
+
script = `const ${variableName} = ()=>'';` + script;
|
|
2162
|
+
}
|
|
2163
|
+
else {
|
|
2164
|
+
variables.add(variableName);
|
|
2165
|
+
script = `const ${variableName} = '';` + script;
|
|
2166
|
+
}
|
|
2167
|
+
}
|
|
2168
|
+
}
|
|
2169
|
+
catch (error) {
|
|
2170
|
+
if (!(error instanceof Error)) {
|
|
2171
|
+
throw error;
|
|
2172
|
+
}
|
|
2173
|
+
throw new ParseError(spaceTrim$1((block) => `
|
|
2174
|
+
Can not extract variables from the script
|
|
2175
|
+
${block(error.stack || error.message)}
|
|
2176
|
+
|
|
2177
|
+
Found variables:
|
|
2178
|
+
${Array.from(variables)
|
|
2179
|
+
.map((variableName, i) => `${i + 1}) ${variableName}`)
|
|
2180
|
+
.join('\n')}
|
|
2181
|
+
|
|
2182
|
+
|
|
2183
|
+
The script:
|
|
2184
|
+
|
|
2185
|
+
\`\`\`javascript
|
|
2186
|
+
${block(originalScript)}
|
|
2187
|
+
\`\`\`
|
|
2188
|
+
`));
|
|
2189
|
+
}
|
|
2190
|
+
return variables;
|
|
2191
|
+
}
|
|
2192
|
+
/**
|
|
2193
|
+
* TODO: [🔣] Support for multiple languages - python, java,...
|
|
2194
|
+
*/
|
|
2195
|
+
|
|
2119
2196
|
/**
|
|
2120
2197
|
* Parses the task and returns the set of all used parameters
|
|
2121
2198
|
*
|
|
@@ -2125,24 +2202,26 @@ function addUsage(...usageItems) {
|
|
|
2125
2202
|
* @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
|
|
2126
2203
|
*/
|
|
2127
2204
|
function extractParameterNamesFromTask(task) {
|
|
2128
|
-
const { title, description,
|
|
2205
|
+
const { title, description, taskType, content, preparedContent, jokerParameterNames, foreach } = task;
|
|
2129
2206
|
const parameterNames = new Set();
|
|
2207
|
+
let contentParameters;
|
|
2208
|
+
if (taskType !== 'SCRIPT_TASK') {
|
|
2209
|
+
contentParameters = extractParameterNames(content);
|
|
2210
|
+
}
|
|
2211
|
+
else {
|
|
2212
|
+
// TODO: What if script is not javascript?
|
|
2213
|
+
// const { contentLanguage } = task;
|
|
2214
|
+
// if (contentLanguage !== 'javascript') {
|
|
2215
|
+
contentParameters = extractVariablesFromJavascript(content);
|
|
2216
|
+
}
|
|
2130
2217
|
for (const parameterName of [
|
|
2131
2218
|
...extractParameterNames(title),
|
|
2132
2219
|
...extractParameterNames(description || ''),
|
|
2133
|
-
...
|
|
2220
|
+
...contentParameters,
|
|
2134
2221
|
...extractParameterNames(preparedContent || ''),
|
|
2135
2222
|
]) {
|
|
2136
2223
|
parameterNames.add(parameterName);
|
|
2137
2224
|
}
|
|
2138
|
-
/*/
|
|
2139
|
-
// TODO: [🙊] Fix `extractVariablesFromScript` or delete
|
|
2140
|
-
if (taskType === 'SCRIPT_TASK') {
|
|
2141
|
-
for (const parameterName of extractVariablesFromScript(content)) {
|
|
2142
|
-
parameterNames.add(parameterName);
|
|
2143
|
-
}
|
|
2144
|
-
}
|
|
2145
|
-
/**/
|
|
2146
2225
|
for (const jokerName of jokerParameterNames || []) {
|
|
2147
2226
|
parameterNames.add(jokerName);
|
|
2148
2227
|
}
|
|
@@ -9826,7 +9905,7 @@ function preserve(func) {
|
|
|
9826
9905
|
* Warning: It is used for testing and mocking
|
|
9827
9906
|
* **NOT intended to use in the production** due to its unsafe nature, use `JavascriptExecutionTools` instead.
|
|
9828
9907
|
*
|
|
9829
|
-
* @public exported from `@promptbook/
|
|
9908
|
+
* @public exported from `@promptbook/javascript`
|
|
9830
9909
|
*/
|
|
9831
9910
|
class JavascriptEvalExecutionTools {
|
|
9832
9911
|
constructor(options) {
|
|
@@ -9932,8 +10011,8 @@ class JavascriptEvalExecutionTools {
|
|
|
9932
10011
|
// Note: Custom functions are exposed to the current scope as variables
|
|
9933
10012
|
`const ${functionName} = customFunctions.${functionName};`)
|
|
9934
10013
|
.join('\n');
|
|
9935
|
-
script = templateParameters(script, parameters);
|
|
9936
|
-
// <-
|
|
10014
|
+
// script = templateParameters(script, parameters);
|
|
10015
|
+
// <- TODO: [🧠][🥳] Should be this is one of two variants how to use parameters in script
|
|
9937
10016
|
const statementToEvaluate = spaceTrim((block) => `
|
|
9938
10017
|
|
|
9939
10018
|
// Build-in functions:
|
|
@@ -10024,7 +10103,7 @@ class JavascriptEvalExecutionTools {
|
|
|
10024
10103
|
* Placeholder for better implementation of JavascriptExecutionTools - some propper sandboxing
|
|
10025
10104
|
*
|
|
10026
10105
|
* @alias JavascriptExecutionTools
|
|
10027
|
-
* @public exported from `@promptbook/
|
|
10106
|
+
* @public exported from `@promptbook/javascript`
|
|
10028
10107
|
*/
|
|
10029
10108
|
const JavascriptExecutionTools = JavascriptEvalExecutionTools;
|
|
10030
10109
|
|
|
@@ -10367,6 +10446,22 @@ async function createCollectionFromDirectory(rootPath, tools, options) {
|
|
|
10367
10446
|
* TODO: Maybe move from `@promptbook/node` to `@promptbook/core` as we removes direct dependency on `fs`
|
|
10368
10447
|
*/
|
|
10369
10448
|
|
|
10449
|
+
/**
|
|
10450
|
+
* Provides script execution tools
|
|
10451
|
+
*
|
|
10452
|
+
* @public exported from `@promptbook/node`
|
|
10453
|
+
*/
|
|
10454
|
+
async function $provideScriptingForNode(options) {
|
|
10455
|
+
if (!$isRunningInNode()) {
|
|
10456
|
+
throw new EnvironmentMismatchError('Function `$provideScriptingForNode` works only in Node.js environment');
|
|
10457
|
+
}
|
|
10458
|
+
// TODO: [🔱] Do here auto-installation
|
|
10459
|
+
return [new JavascriptExecutionTools(options)];
|
|
10460
|
+
}
|
|
10461
|
+
/**
|
|
10462
|
+
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
10463
|
+
*/
|
|
10464
|
+
|
|
10370
10465
|
/**
|
|
10371
10466
|
* Stringify the PipelineJson with proper formatting
|
|
10372
10467
|
*
|
|
@@ -10485,5 +10580,5 @@ async function $execCommands({ commands, cwd, crashOnError, }) {
|
|
|
10485
10580
|
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
10486
10581
|
*/
|
|
10487
10582
|
|
|
10488
|
-
export { $execCommand, $execCommands, $provideExecutablesForNode, $provideExecutionToolsForNode, $provideFilesystemForNode, $provideLlmToolsConfigurationFromEnv, $provideLlmToolsFromEnv, $provideScrapersForNode, BOOK_LANGUAGE_VERSION, FileCacheStorage, PROMPTBOOK_ENGINE_VERSION, createCollectionFromDirectory };
|
|
10583
|
+
export { $execCommand, $execCommands, $provideExecutablesForNode, $provideExecutionToolsForNode, $provideFilesystemForNode, $provideLlmToolsConfigurationFromEnv, $provideLlmToolsFromEnv, $provideScrapersForNode, $provideScriptingForNode, BOOK_LANGUAGE_VERSION, FileCacheStorage, PROMPTBOOK_ENGINE_VERSION, createCollectionFromDirectory };
|
|
10489
10584
|
//# sourceMappingURL=index.es.js.map
|