tune-sdk 0.3.2 → 0.3.4

package/README.md

@@ -94,7 +94,7 @@ image generated
 ```
 
 
-## CLI
+## Command Line
 
 ```bash
 # install tune globally
@@ -115,6 +115,44 @@ tune --set test="hello" --user "@test" --system "You are echo you print everytht
 
 ```
 
+### Static web server + context over WebSocket
+
+Make simple web apps that share the same tools, files, and models available in Tune Chat. Tune Chat and the web app share the same context:
+
+```javascript
+// Read files
+await ctx.read("path/to/file")
+
+// Write files
+await ctx.write("path/to/file", content)
+
+// Execute tools
+let result = await ctx.exec("tool", { param: "value" })
+// Note that `result` is always a string. If you expect JSON:
+result = JSON.parse(result)
+
+// Also render errors to the user, since you won’t be able to see and debug them otherwise.
+
+// Call LLM
+const result = await ctx.file2run({ user: "hi" })
+```
+
+Create an app, e.g. `index.html`:
+
+```html
+...
+<!-- Load the context into `window.ctx` -->
+<script src="/contextws.js"></script>
+...
+```
+
+Run the static web server from the folder:
+
+```bash
+$ tune ws
+
+listening on http://localhost:8080
+```
 
 ## Javascript SDK
 `npm install tune-sdk`
@@ -212,11 +250,32 @@ You can access tune manuals and available middlewares manuals from
 system:
 @man include all manuals for all connected packages
 @man/ - list all the manuals, like list directory
-@man/tune - get manual for tune core package 
+@man/tune-sdk - get manual for tune core package 
 @man/tune-basic-toolset - get manual for tune-basic-tool set package
 
+read any of it as a file
 tool_call: rf { "filename": "man/tune-basic-toolset"}
 tool_result:
 @man/tune-basic-toolset
+```
+
+To connect man middleware in `default.ctx.js`:
 
+```javascript
+const man = require('tune-sdk/man')
+
+module.exports = [
+    ...
+    man(),
+    ...
+]
 ```
+
+To expose `README.md` of your npm package as `man/<package-name>`, in your package/src/index.js add:
+```javascript
+const man = require("tune-sdk/man");
+
+// this method will read package.json and README.md
+man.add(__dirname)
+````
+

package/dist/tune.js

@@ -1219,7 +1219,7 @@ Context.prototype.exec = (async function(name, args) {
   }
   return _ref;
 });
-Context.prototype.write = (async function(name, args) {
+Context.prototype.write = (async function(name, content, props) {
   var ws, cur, res, _res, _ref;
   ws = (this.ws || [])
     .slice();
@@ -1227,7 +1227,7 @@ Context.prototype.write = (async function(name, args) {
   cur = ws.shift();
   _res = [];
   while (cur) {
-    res = await cur.call(this, name, args, this);
+    res = await cur.call(this, name, content, props);
     if (res) break;
     if (typeof(_ref = (cur = ws.shift())) !== 'undefined') _res.push(_ref);
   }
@@ -1730,11 +1730,16 @@ async function ast2payload(ast, ctx) {
   roles.push(lastRole);
 
   function transformRoles(memo, item, index, arr) {
-    var tcItem, lines, toolIndex, tc;
-    if ((item.role === "user" || item.role === "system" || item.role === "tool_call")) item.content = (Array.isArray(item.content) ? item.content.map((function(item) {
-      if (item.text) item.text = unescape(item.text);
+    var escapeOptions, tcItem, lines, toolIndex, tc;
+    var escapeOptions;
+    escapeOptions = {
+      vars: item.role === "user" || item.role === "system" || item.role === "tool_call",
+      roles: true
+    };
+    item.content = (Array.isArray(item.content) ? item.content.map((function(item) {
+      if (item.text) item.text = unescape(item.text, escapeOptions);
       return item;
-    })) : unescape(item.content));
+    })) : unescape(item.content, escapeOptions));
 
     function findToolCalls() {
       var item1, _i, _ref, _len;
@@ -2018,7 +2023,10 @@ async function toolCall(payload, ctx) {
     transformRes;
     var content;
     content = transformRes(res);
-    if ((((typeof tools !== "undefined") && (tools !== null) && !Number.isNaN(tools) && (typeof tools[tc.name] !== "undefined") && (tools[tc.name] !== null) && !Number.isNaN(tools[tc.name]) && (typeof tools[tc.name].escapeOutput !== "undefined") && (tools[tc.name].escapeOutput !== null) && !Number.isNaN(tools[tc.name].escapeOutput)) ? tools[tc.name].escapeOutput : (((typeof true !== "undefined") && (true !== null) && !Number.isNaN(true)) ? true : undefined))) content = escape(content);
+    if ((((typeof tools !== "undefined") && (tools !== null) && !Number.isNaN(tools) && (typeof tools[tc.name] !== "undefined") && (tools[tc.name] !== null) && !Number.isNaN(tools[tc.name]) && (typeof tools[tc.name].escapeOutput !== "undefined") && (tools[tc.name].escapeOutput !== null) && !Number.isNaN(tools[tc.name].escapeOutput)) ? tools[tc.name].escapeOutput : (((typeof true !== "undefined") && (true !== null) && !Number.isNaN(true)) ? true : undefined))) content = escape(content, {
+      vars: true,
+      roles: false
+    });
     return {
       role: "tool",
       id: item.id,
@@ -2282,7 +2290,7 @@ function text2run(text, ctx, opts) {
 }
 text2run;
 async function file2run(args, params, ctx) {
-  var lctx, text, stop, errors, turnsSaved, node, longFormatRegex, isLong, initialText, response, res, r, chunk, itergMKZ8fG, _ref;
+  var lctx, text, stop, errors, turnsSaved, node, longFormatRegex, isLong, initialText, response, res, r, chunk, iterg8EYRCS, _ref;
   var lctx;
   lctx = ctx.clone();
   if (params) lctx.ms.unshift(envmd(params));
@@ -2374,7 +2382,7 @@ async function file2run(args, params, ctx) {
       hookTurnEnd: save
     });
     chunk = {};
-    itergMKZ8fG = new AsyncIter();
+    iterg8EYRCS = new AsyncIter();
     (async function($lastRes) {
       var _ref;
       try {
@@ -2382,20 +2390,20 @@ async function file2run(args, params, ctx) {
           chunk = await r.next();
           res = (chunk.value || "");
           $lastRes = transformOutput(res) || $lastRes;
-          itergMKZ8fG.result = {
+          iterg8EYRCS.result = {
             value: $lastRes
           }
         }
-        _ref = itergMKZ8fG.result = {
+        _ref = iterg8EYRCS.result = {
           value: $lastRes,
           done: true
         }
       } catch (e) {
-        _ref = (itergMKZ8fG.err = e);
+        _ref = (iterg8EYRCS.err = e);
       }
       return _ref;
     })();
-    _ref = itergMKZ8fG;
+    _ref = iterg8EYRCS;
   }
   return _ref;
 }
@@ -2405,6 +2413,10 @@ function msg2text(msg, long) {
   var _ref, _ref0, _ref1;
 
   function mkline(role, content) {
+    content = escape(content, {
+      vars: role === "user" || role === "system",
+      roles: true
+    });
     return (long ? tpl("{role}:{new_line}{content}", {
       role: role,
       content: content,
@@ -2503,7 +2515,9 @@ function msg2text(msg, long) {
               return tpl("{role}: {name}{ args}{\ntext}", {
                 name: tc.function.name,
                 args: args,
-                text: text,
+                text: escape(text, {
+                  roles: true
+                }),
                 role: (long ? "tool_call" : "tc")
               });
             }))
@@ -2546,18 +2560,35 @@ function msg2role(msg) {
 }
 msg2role;
 
-function escape(text) {
-  return String((((typeof text !== "undefined") && (text !== null) && !Number.isNaN(text)) ? text : (((typeof "" !== "undefined") && ("" !== null) && !Number.isNaN("")) ? "" : undefined)))
-    .replace(/@/g, "\\@")
-    .replace(/^(s|u|a|c|tr|tc|err|system|user|comment|assistant|tool_call|tool_result|error):/gm, "\\$1:");
+function escape(text, opts) {
+  var result;
+  var opts;
+  var result;
+  opts = opts || {
+    vars: true,
+    roles: true
+  }
+  result = String((((typeof text !== "undefined") && (text !== null) && !Number.isNaN(text)) ? text : (((typeof "" !== "undefined") && ("" !== null) && !Number.isNaN("")) ? "" : undefined)));
+  if (opts.vars) result = result.replace(/@/g, "\\@");
+  if (opts.roles) result = result.replace(/^(s|u|a|c|tr|tc|err|system|user|comment|assistant|tool_call|tool_result|error):/gm, "\\$1:");
+  return result;
 }
 escape;
 
-function unescape(text) {
-  return String((((typeof text !== "undefined") && (text !== null) && !Number.isNaN(text)) ? text : (((typeof "" !== "undefined") && ("" !== null) && !Number.isNaN("")) ? "" : undefined)))
+function unescape(text, opts) {
+  var result;
+  var opts;
+  var result;
+  opts = opts || {
+    vars: true,
+    roles: true
+  }
+  result = String((((typeof text !== "undefined") && (text !== null) && !Number.isNaN(text)) ? text : (((typeof "" !== "undefined") && ("" !== null) && !Number.isNaN("")) ? "" : undefined)));
+  if (opts.vars) result = result
     .replace(/\\(?<item>@{1,2}\{\s*[~\.\-\w/]+\s*)(?<proc>(?:\s*\|\s*\w+(?:\s+\w+)*)*\})/g, "$<item>$<proc>")
-    .replace(/\\(?<item>@{1,2}[~\.\-\w/]+)/g, "$<item>")
-    .replace(/^\\(s|system|u|user|a|assistant|c|comment|tr|tool_result|tc|tool_call|err|error):/gm, "$1:");
+    .replace(/\\(?<item>@{1,2}[~\.\-\w/]+)/g, "$<item>");
+  if (opts.roles) result = result.replace(/^\\(s|system|u|user|a|assistant|c|comment|tr|tool_result|tc|tool_call|err|error):/gm, "$1:");
+  return result;
 }
 unescape;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tune-sdk",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "chat with llm in a text file. core package",
   "main": "dist/tune.js",
   "module": "dist/tune.mjs",

package/src/man.js

@@ -34,7 +34,7 @@ function read(man) {
   if (!fs.existsSync(filename)) {
     return `file ${filename} not found`
   }
-  return fs.readFileSync(filename)
+  return fs.readFileSync(filename, "utf8")
 }
 
 module.exports = ({ mount } = {}) => {