@scout9/app 1.0.0-alpha.0.4.0 → 1.0.0-alpha.0.4.2

package/README.md

@@ -1,33 +1,22 @@
 # @scout9/app
+*(soon to be renamed to @scout9/pmt)*
 
-Try out the alpha version
+Application runtime to deploy and drive your [PMT's](https://scout9.com) custom conversational logic.
 
 `npm create scout9@latest my-app`
 
-### Alpha (Not Released)
-
 * Chatbots 🤮
 * One on One Communication 😎
 * Scale? 🤷‍
-* 💎 [Scout9](https://scout9.com)
+* 💎 [Scout9's PMT](https://scout9.com)
 
-Scout9's Persona Model Transforming (PMT) technology auto crafts messages in your voice on SMS/Email legacy channels. This technology enables you to personally connect with **thousands of customers simultaneously**.
+Scout9's Persona Model Transform (PMT) **guarantees** to craft auto generated messages into your words, so that you can spend less time typing repetitive messages and more time on more pressing customer interactions.
 
-**Perfect for handling repetitive requests**
+**Note**: If your PMT cannot guarantee to transform a particular message in your own words, it will forward the conversation to you to handle personally. 
 
 ### Commands
 * `npm install -g scout9`
 * `scout9 dev`
 * `scout9 build`
 * `scout9 deploy`
-* `scout9 sync` (coming soon)
-
-
-
-#### Thanks to our early backers using Scout9 to improve their customer experience
-* [REI](https://rei.com): Supply chain procurement SMS auto replies
-* [Microsoft](https://microsoft.com): Azure customer account support SMS auto replies
-* [Accenture](https://accenture.com): Improving sales pipelines
-* [Paco Equip](https://pacoequip.com): Improve customer contact and support speed
-* [Campbells](https://cambells.com): Bill and lading confirmation SMS auto replies
-* [WelcomeHome](https://getwelocomehome.com): Dedicated House Manager text to maintenance
+* `scout9 sync` *(coming soon)*

package/dist/{dev-0876e8d1.cjs → dev-89d0d9da.cjs}

@@ -29824,7 +29824,7 @@ common.createRequestFunction = createRequestFunction;
 var configuration = {};
 
 var name$1 = "@scout9/admin";
-var version$2 = "1.0.0-alpha.0.0.50";
+var version$2 = "1.0.0-alpha.0.0.51";
 var description$1 = "";
 var main$2 = "./build/index.js";
 var types$1 = "./build/index.d.ts";
@@ -35049,7 +35049,7 @@ function _loadUserPackageJson() {
           targetPkgUrl = isTest ? packageTestJsonUrl : packageJsonUrl;
           _context2.t0 = JSON;
           _context2.next = 10;
-          return fs__default["default"].readFile(new URL(targetPkgUrl, (typeof document === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : (document.currentScript && document.currentScript.src || new URL('dev-0876e8d1.js', document.baseURI).href))), 'utf-8');
+          return fs__default["default"].readFile(new URL(targetPkgUrl, (typeof document === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : (document.currentScript && document.currentScript.src || new URL('dev-89d0d9da.js', document.baseURI).href))), 'utf-8');
         case 10:
           _context2.t1 = _context2.sent;
           pkg = _context2.t0.parse.call(_context2.t0, _context2.t1);

package/dist/{index-9822d519.cjs → index-d60f8919.cjs}

@@ -1,7 +1,7 @@
 'use strict';
 
 var spirits = require("./spirits-5c9243a1.cjs");
-var dev = require("./dev-0876e8d1.cjs");
+var dev = require("./dev-89d0d9da.cjs");
 var macros = require("./macros-e4105c56.cjs");
 var require$$0 = require('fs');
 var require$$2$1 = require('events');
@@ -29483,7 +29483,7 @@ class Body {
     }
     const {
       toFormData
-    } = await Promise.resolve().then(function () { return require("./multipart-parser-d7d5d504.cjs"); });
+    } = await Promise.resolve().then(function () { return require("./multipart-parser-6df56089.cjs"); });
     return toFormData(this.body, ct);
   }
 
@@ -41884,7 +41884,7 @@ function _loadUserPackageJson() {
           targetPkgUrl = isTest ? packageTestJsonUrl : packageJsonUrl;
           _context.t0 = JSON;
           _context.next = 10;
-          return fs__default["default"].readFile(new URL(targetPkgUrl, (typeof document === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : (document.currentScript && document.currentScript.src || new URL('index-9822d519.js', document.baseURI).href))), 'utf-8');
+          return fs__default["default"].readFile(new URL(targetPkgUrl, (typeof document === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : (document.currentScript && document.currentScript.src || new URL('index-d60f8919.js', document.baseURI).href))), 'utf-8');
         case 10:
           _context.t1 = _context.sent;
           pkg = _context.t0.parse.call(_context.t0, _context.t1);
@@ -41997,6 +41997,7 @@ var _hint = {
   value: "make sure the context is properly instantiated before running workflow."
 };
 
+var _excluded = ["event"];
 function handleAxiosResponse(res) {
   if (res.status === 200) {
     return res.data;
@@ -42007,6 +42008,20 @@ function handleAxiosResponse(res) {
   }
 }
 
+/**
+ * Util function to prevent macros sending event payloads larger than x kilobytes
+ */
+function processPayload(payload) {
+  var maxKb = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 250;
+  if (Buffer.byteLength(JSON.stringify(payload.event), 'utf8') / 1024 > maxKb) {
+    payload.event;
+      var rest = spirits._objectWithoutProperties(payload, _excluded); // Remove event from payload, too large
+    return rest;
+  } else {
+    return payload;
+  }
+}
+
 /**
  * The `did` macro takes a given prompt and infers a binary `true` or `false` result in relation to the prompt's subject actor and the prompt's inquiry.
  * @param {string} prompt
@@ -42016,6 +42031,57 @@ function did(_x) {
   return _did.apply(this, arguments);
 }
 
+/**
+ * The `does` macro takes a given prompt and infers a binary `true` or `false` result in relation to the prompt's subject actor and the prompt's inquiry for the given immediate message
+ *
+ * Only use this if you want to evaluate the latest message, otherwise use did() which uses all messages
+ * @param {string} prompt
+ * @param {'customer' | 'agent'} [relation]
+ * @return {Promise<boolean>}
+ */
+function _did() {
+  _did = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee(prompt) {
+    var convoId, event, _yield$Scout9Api$did$, value;
+    return spirits._regeneratorRuntime().wrap(function _callee$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          convoId = MacroGlobals.$convo();
+          event = MacroGlobals.event();
+          event.conversation.$id = convoId;
+          event.conversation.id = convoId;
+          if (convoId) {
+            _context2.next = 6;
+            break;
+          }
+          throw new Error("Internal: Unable to contextualize did response for \"".concat(prompt, "\""));
+        case 6:
+          _context2.next = 8;
+          return new dev.build.Scout9Api(new dev.build.Configuration({
+            apiKey: process.env.SCOUT9_API_KEY
+          })).did(processPayload({
+            prompt: prompt,
+            convoId: convoId,
+            event: event
+          })).then(handleAxiosResponse)["catch"](function (err) {
+            console.error('Error in did macro', err);
+            throw err;
+          });
+        case 8:
+          _yield$Scout9Api$did$ = _context2.sent;
+          value = _yield$Scout9Api$did$.value;
+          return _context2.abrupt("return", value);
+        case 11:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee);
+  }));
+  return _did.apply(this, arguments);
+}
+function does(_x2) {
+  return _does.apply(this, arguments);
+}
+
 /**
  * @typedef {import('@scout9/admin').MacroContextInputExamples} ContextExamples
  * @typedef {import('@scout9/admin').MacroContextValue} ContextOutput
@@ -42038,85 +42104,92 @@ function did(_x) {
  * @param {ContextExamples} [examples] - Examples to the macro to ensure a consistent data structure.
  * @return {Promise<ContextOutput>}
  */
-function _did() {
-  _did = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee(prompt) {
-    var convoId, event, _yield$Scout9Api$did$, value;
-    return spirits._regeneratorRuntime().wrap(function _callee$(_context2) {
-      while (1) switch (_context2.prev = _context2.next) {
+function _does() {
+  _does = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee2(prompt) {
+    var relation,
+      convoId,
+      event,
+      _yield$Scout9Api$does,
+      value,
+      _args2 = arguments;
+    return spirits._regeneratorRuntime().wrap(function _callee2$(_context3) {
+      while (1) switch (_context3.prev = _context3.next) {
         case 0:
+          relation = _args2.length > 1 && _args2[1] !== undefined ? _args2[1] : 'customer';
           convoId = MacroGlobals.$convo();
           event = MacroGlobals.event();
           event.conversation.$id = convoId;
           event.conversation.id = convoId;
           if (convoId) {
-            _context2.next = 6;
+            _context3.next = 7;
             break;
           }
-          throw new Error("Internal: Unable to contextualize did response for \"".concat(prompt, "\""));
-        case 6:
-          _context2.next = 8;
+          throw new Error("Internal: Unable to contextualize does response for \"".concat(prompt, "\""));
+        case 7:
+          _context3.next = 9;
           return new dev.build.Scout9Api(new dev.build.Configuration({
             apiKey: process.env.SCOUT9_API_KEY
-          })).did({
+          })).does(processPayload({
             prompt: prompt,
             convoId: convoId,
+            role: relation,
             event: event
-          }).then(handleAxiosResponse);
-        case 8:
-          _yield$Scout9Api$did$ = _context2.sent["catch"](function (err) {
+          })).then(handleAxiosResponse)["catch"](function (err) {
             console.error('Error in did macro', err);
             throw err;
           });
-          value = _yield$Scout9Api$did$.value;
-          return _context2.abrupt("return", value);
-        case 11:
+        case 9:
+          _yield$Scout9Api$does = _context3.sent;
+          value = _yield$Scout9Api$does.value;
+          return _context3.abrupt("return", value);
+        case 12:
         case "end":
-          return _context2.stop();
+          return _context3.stop();
       }
-    }, _callee);
+    }, _callee2);
   }));
-  return _did.apply(this, arguments);
+  return _does.apply(this, arguments);
 }
-function context(_x2, _x3) {
+function context(_x3, _x4) {
   return _context.apply(this, arguments);
 }
 function _context() {
-  _context = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee2(prompt, examples) {
+  _context = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee3(prompt, examples) {
     var convoId, event, _yield$Scout9Api$capt, value;
-    return spirits._regeneratorRuntime().wrap(function _callee2$(_context3) {
-      while (1) switch (_context3.prev = _context3.next) {
+    return spirits._regeneratorRuntime().wrap(function _callee3$(_context4) {
+      while (1) switch (_context4.prev = _context4.next) {
         case 0:
           convoId = MacroGlobals.$convo();
           event = MacroGlobals.event();
           event.conversation.$id = convoId;
           event.conversation.id = convoId;
           if (convoId) {
-            _context3.next = 6;
+            _context4.next = 6;
             break;
           }
           throw new Error("Internal: Unable to contextualize did response for \"".concat(prompt, "\""));
         case 6:
-          _context3.next = 8;
+          _context4.next = 8;
           return new dev.build.Scout9Api(new dev.build.Configuration({
             apiKey: process.env.SCOUT9_API_KEY
-          })).captureContext({
+          })).captureContext(processPayload({
             prompt: prompt,
             examples: examples,
             convoId: convoId,
             event: event
-          }).then(handleAxiosResponse);
-        case 8:
-          _yield$Scout9Api$capt = _context3.sent["catch"](function (err) {
+          })).then(handleAxiosResponse)["catch"](function (err) {
             console.error('Error in context macro', err);
             throw err;
           });
+        case 8:
+          _yield$Scout9Api$capt = _context4.sent;
           value = _yield$Scout9Api$capt.value;
-          return _context3.abrupt("return", value);
+          return _context4.abrupt("return", value);
         case 11:
         case "end":
-          return _context3.stop();
+          return _context4.stop();
       }
-    }, _callee2);
+    }, _callee3);
   }));
   return _context.apply(this, arguments);
 }
@@ -43115,7 +43188,7 @@ var ProjectFiles = /*#__PURE__*/function () {
   return ProjectFiles;
 }();
 
-var __filename$1 = node_url.fileURLToPath((typeof document === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : (document.currentScript && document.currentScript.src || new URL('index-9822d519.js', document.baseURI).href)));
+var __filename$1 = node_url.fileURLToPath((typeof document === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : (document.currentScript && document.currentScript.src || new URL('index-d60f8919.js', document.baseURI).href)));
 var __dirname$1 = path__default["default"].dirname(__filename$1);
 function zipDirectory(source, out) {
   var archive = archiver$1('tar', {
@@ -43330,7 +43403,7 @@ function _buildApp() {
         case 11:
           _context4.t0 = JSON;
           _context4.next = 14;
-          return fs__default["default"].readFile(new URL(templatePackagePath, (typeof document === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : (document.currentScript && document.currentScript.src || new URL('index-9822d519.js', document.baseURI).href))), 'utf-8');
+          return fs__default["default"].readFile(new URL(templatePackagePath, (typeof document === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : (document.currentScript && document.currentScript.src || new URL('index-d60f8919.js', document.baseURI).href))), 'utf-8');
         case 14:
           _context4.t1 = _context4.sent;
           packageTemplate = _context4.t0.parse.call(_context4.t0, _context4.t1);
@@ -44553,6 +44626,7 @@ exports.File = File;
 exports.FormData = FormData;
 exports.context = context;
 exports.did = did;
+exports.does = does;
 exports.json = json;
 exports.run = run;
 exports.sendEvent = sendEvent;

package/dist/index.cjs

@@ -2,8 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var index = require("./index-9822d519.cjs");
-var dev = require("./dev-0876e8d1.cjs");
+var index = require("./index-d60f8919.cjs");
+var dev = require("./dev-89d0d9da.cjs");
 require("./spirits-5c9243a1.cjs");
 require("./macros-e4105c56.cjs");
 require('fs');
@@ -45,6 +45,7 @@ require('node:process');
 exports.EventResponse = index.EventResponse;
 exports.context = index.context;
 exports.did = index.did;
+exports.does = index.does;
 exports.json = index.json;
 exports.run = index.run;
 exports.sendEvent = index.sendEvent;

package/dist/{multipart-parser-d7d5d504.cjs → multipart-parser-6df56089.cjs}

@@ -2,9 +2,9 @@
 
 require('node:fs');
 require('node:path');
-var index = require("./index-9822d519.cjs");
+var index = require("./index-d60f8919.cjs");
 require("./spirits-5c9243a1.cjs");
-require("./dev-0876e8d1.cjs");
+require("./dev-89d0d9da.cjs");
 require('util');
 require('stream');
 require('path');

package/dist/testing-tools.cjs

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var dev = require("./dev-0876e8d1.cjs");
+var dev = require("./dev-89d0d9da.cjs");
 require("./spirits-5c9243a1.cjs");
 require('util');
 require('stream');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scout9/app",
-  "version": "1.0.0-alpha.0.4.0",
+  "version": "1.0.0-alpha.0.4.2",
   "description": "Build and deploy your Scout9 app for SMS auto replies",
   "publishConfig": {
     "access": "public"
@@ -85,7 +85,7 @@
     "zod-to-ts": "^1.2.0"
   },
   "dependencies": {
-    "@scout9/admin": "^1.0.0-alpha.0.0.39",
+    "@scout9/admin": "^1.0.0-alpha.0.0.51",
     "@scout9/crm": "^1.0.0-alpha.0.0.4",
     "archiver": "^6.0.1",
     "body-parser": "^1.20.2",

package/src/core/templates/app.js

@@ -646,13 +646,19 @@ app.listen(process.env.PORT || 8080, err => {
    |\\_________\\|_______|\\|_______|\\|_______|    \\|__|  \\|_______|
    \\|_________|                                                  
 `;
-  const art_auto_reply = `    ___         __           ____             __         __   
-   /   | __  __/ /_____     / __ \\___  ____  / /_  __   / /   
-  / /| |/ / / / __/ __ \\   / /_/ / _ \\/ __ \\/ / / / /  / /    
- / ___ / /_/ / /_/ /_/ /  / _, _/  __/ /_/ / / /_/ /  /_/     
-/_/  |_\\__,_/\\__/\\____/  /_/ |_|\\___/ .___/_/\\__, /  (_)      
-                                   /_/      /____/            
-  
+  const art_pmt = `
+ _______   __       __  ________ 
+|       \ |  \     /  \|        \
+| $$$$$$$\| $$\   /  $$ \$$$$$$$$
+| $$__/ $$| $$$\ /  $$$   | $$   
+| $$    $$| $$$$\  $$$$   | $$   
+| $$$$$$$ | $$\$$ $$ $$   | $$   
+| $$      | $$ \$$$| $$   | $$   
+| $$      | $$  \$ | $$   | $$   
+ \$$       \$$      \$$    \$$   
+                                 
+                                 
+                                 
 `;
   const protocol = process.env.PROTOCOL || 'http';
   const host = process.env.HOST || 'localhost';
@@ -660,7 +666,7 @@ app.listen(process.env.PORT || 8080, err => {
   const fullUrl = `${protocol}://${host}:${port}`;
   if (dev) {
     console.log(colors.bold(colors.green(art_scout9)));
-    console.log(colors.bold(colors.cyan(art_auto_reply)));
+    console.log(colors.bold(colors.cyan(art_pmt)));
     console.log(`${colors.grey(`${colors.cyan('>')} Running ${colors.bold(colors.white('Scout9'))}`)} ${colors.bold(
       colors.red(colors.bgBlack('auto-reply')))} ${colors.grey('dev environment on')} ${fullUrl}`);
   } else {

package/src/runtime/macros/builder.js

@@ -11,10 +11,23 @@ function handleAxiosResponse(res) {
   } else {
     // @TODO remove log
     console.error('Macro Failed To Run', res.status, res.statusText, res.data);
-    throw new Error(`${res.status} ${res.statusText}`)
+    throw new Error(`${res.status} ${res.statusText}`);
   }
 }
 
+/**
+ * Util function to prevent macros sending event payloads larger than x kilobytes
+ */
+function processPayload(payload, maxKb = 250) {
+  if ((Buffer.byteLength(JSON.stringify(payload.event), 'utf8') / 1024) > maxKb) {
+    const {event, ...rest} = payload; // Remove event from payload, too large
+    return rest;
+  } else {
+    return payload;
+  }
+}
+
+
 /**
  * The `did` macro takes a given prompt and infers a binary `true` or `false` result in relation to the prompt's subject actor and the prompt's inquiry.
  * @param {string} prompt
@@ -28,16 +41,49 @@ export async function did(prompt) {
   if (!convoId) {
     throw new Error(`Internal: Unable to contextualize did response for "${prompt}"`);
   }
-  const {value} = (await (new Scout9Api(new Configuration({apiKey: process.env.SCOUT9_API_KEY}))).did({
+  const {value} = (await (new Scout9Api(new Configuration({apiKey: process.env.SCOUT9_API_KEY}))).did(processPayload({
     prompt,
     convoId,
     event
-  })
-    .then(handleAxiosResponse))
+  }))
+    .then(handleAxiosResponse)
     .catch((err) => {
       console.error('Error in did macro', err);
       throw err;
-    });
+    }));
+  return value;
+}
+
+/**
+ * The `does` macro takes a given prompt and infers a binary `true` or `false` result in relation to the prompt's subject actor and the prompt's inquiry for the given immediate message
+ *
+ * Only use this if you want to evaluate the latest message, otherwise use did() which uses all messages
+ * @param {string} prompt
+ * @param {'customer' | 'agent'} [relation]
+ * @return {Promise<boolean>}
+ */
+export async function does(prompt, relation = 'customer') {
+  const convoId = MacroGlobals.$convo();
+  const event = MacroGlobals.event();
+  event.conversation.$id = convoId;
+  event.conversation.id = convoId;
+  if (!convoId) {
+    throw new Error(`Internal: Unable to contextualize does response for "${prompt}"`);
+  }
+
+  const {value} = (await (new Scout9Api(new Configuration({apiKey: process.env.SCOUT9_API_KEY}))).does(
+    processPayload({
+      prompt,
+      convoId,
+      role: relation,
+      event
+    })
+  )
+    .then(handleAxiosResponse)
+    .catch((err) => {
+      console.error('Error in did macro', err);
+      throw err;
+    }));
   return value;
 }
 
@@ -71,16 +117,17 @@ export async function context(prompt, examples) {
   if (!convoId) {
     throw new Error(`Internal: Unable to contextualize did response for "${prompt}"`);
   }
-  const {value} = (await (new Scout9Api(new Configuration({apiKey: process.env.SCOUT9_API_KEY}))).captureContext({
-    prompt,
-    examples,
-    convoId,
-    event,
-  })
-    .then(handleAxiosResponse))
+  const {value} = (await (new Scout9Api(new Configuration({apiKey: process.env.SCOUT9_API_KEY}))).captureContext(
+    processPayload({
+      prompt,
+      examples,
+      convoId,
+      event
+    }))
+    .then(handleAxiosResponse)
     .catch((err) => {
       console.error('Error in context macro', err);
       throw err;
-    });
+    }));
   return value;
 }