@scout9/app 1.0.0-alpha.0.5.8 → 1.0.0-alpha.0.6.0

package/dist/{spirits-2ab4d673.cjs → spirits-8819b1c9.cjs}

@@ -637,6 +637,7 @@ var _excluded = ["keywords"];
  * @property {Array<import('@scout9/app').Message>} messages
  * @property {import('@scout9/app').Message} message - the message sent by the customer (should exist in messages)
  * @property {import('@scout9/app').Customer} customer
+ * @property {import('@scout9/app').ConversationProgress} progress - progress checklist for manual/auto ingress workflows (needed if conversation progress is not managed by external webhooks or @scout9 apps (ingress app/webhook)
  * @property {any} context
  */
 
@@ -664,6 +665,14 @@ var _excluded = ["keywords"];
  * @property {any} context
  */
 
+/**
+ * @typedef {Object} GenerateOutput
+ * @property {import('@scout9/admin').GenerateResponse | undefined} generate
+ * @property {Array<import('@scout9/app').Message>} messages
+ * @property {import('@scout9/app').Conversation} conversation
+ * @property {any} context
+ */
+
 /**
  * @callback ParseFun
  * @param {string} message - message to send
@@ -683,11 +692,18 @@ var _excluded = ["keywords"];
  * @returns {Promise<import('@scout9/admin').GenerateResponse>}
  */
 
+/**
+ * @callback TransformerFun
+ * @param {import('@scout9/admin').PmtTransformRequest} data - data to generate from
+ * @returns {Promise<import('@scout9/admin').PmtTransformResponse>}
+ */
+
 /**
  * @callback IdGeneratorFun
  * @param {import('@scout9/app').Message['role']} prefix
  * @returns {string}
  */
+
 /**
  * @callback StatusCallback
  * @param {string} message
@@ -702,6 +718,7 @@ var _excluded = ["keywords"];
  * @property {ParseFun} parser
  * @property {WorkflowFun} workflow
  * @property {GenerateFun} generator
+ * @property {TransformerFun} transformer
  * @property {IdGeneratorFun} idGenerator
  * @property {StatusCallback | undefined} [progress]
  */
@@ -723,11 +740,11 @@ var Spirits = {
   customer: function () {
     var _customer = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(input) {
       var _recentUserMessage;
-      var customer, config, parser, workflow, generator, idGenerator, _input$progress, progress, messageBefore, contextBefore, messagesBefore, conversationBefore, conversation, messages, context, message, followup, updateConversation, updateContext, userMessages, recentUserMessage, lockConversation, incrementLockAttempt, _addInstruction, addInstruction, persona, invalidRoles, parsePayload, index, _message, previousUserMessages, oldKeyCount, newKeyCount, noNewContext, slots, hasNoInstructions, hasNoCustomMessage, previousLockAttempt, resettedIntent, _forward, _forwardNote, _iterator, _step, _step$value, forward, forwardNote, instructions, removeInstructions, manualMessage, scheduled, resetIntent, secondsDelay, contextUpsert, anticipate, slotFollowup, _slots, map, i, _anticipate$i, keywords, _slot, slotId, _iterator2, _step2, instruction, _iterator3, _step3, _loop, manualMessageObj, now, generatorPayload, agentMessages, lastAgentMessage;
+      var customer, config, parser, workflow, generator, transformer, idGenerator, _input$progress, progress, messageBefore, contextBefore, messagesBefore, conversationBefore, conversation, messages, context, message, followup, updateConversation, updateContext, userMessages, recentUserMessage, lockConversation, incrementLockAttempt, _addInstruction, addInstruction, persona, invalidRoles, parsePayload, index, _message, previousUserMessages, oldKeyCount, newKeyCount, noNewContext, slots, hasNoInstructions, hasNoCustomMessage, messagesToTransform, previousLockAttempt, resettedIntent, _forward, _forwardNote, _iterator, _step, _step$value, forward, forwardNote, instructions, removeInstructions, manualMessage, scheduled, resetIntent, secondsDelay, contextUpsert, anticipate, slotFollowup, _slots, map, i, _anticipate$i, keywords, _slot, slotId, _iterator3, _step3, instruction, _iterator4, _step4, _loop, manualMessageObj, now, generatorPayload, agentMessages, lastAgentMessage, _iterator2, _step2, transformResponse, _agentMessages, _lastAgentMessage;
       return _regeneratorRuntime().wrap(function _callee$(_context2) {
         while (1) switch (_context2.prev = _context2.next) {
           case 0:
-            customer = input.customer, config = input.config, parser = input.parser, workflow = input.workflow, generator = input.generator, idGenerator = input.idGenerator, _input$progress = input.progress, progress = _input$progress === void 0 ? function (message, level, type, payload) {} : _input$progress, messageBefore = input.message, contextBefore = input.context, messagesBefore = input.messages, conversationBefore = input.conversation;
+            customer = input.customer, config = input.config, parser = input.parser, workflow = input.workflow, generator = input.generator, transformer = input.transformer, idGenerator = input.idGenerator, _input$progress = input.progress, progress = _input$progress === void 0 ? function (message, level, type, payload) {} : _input$progress, messageBefore = input.message, contextBefore = input.context, messagesBefore = input.messages, conversationBefore = input.conversation;
             conversation = input.conversation, messages = input.messages, context = input.context, message = input.message;
             followup = []; // 0. Setup Helpers
             updateConversation = function updateConversation(previousConversation, conversationUpdates) {
@@ -881,6 +898,7 @@ var Spirits = {
               message.intentScore = parsePayload.intentScore;
             }
             message.context = parsePayload.context;
+            message.entities = parsePayload.entities;
             index = messages.findIndex(function (m) {
               return m.content === message.content || m.id === message.id;
             });
@@ -890,6 +908,7 @@ var Spirits = {
                 role: 'customer',
                 content: message,
                 context: parsePayload.context,
+                entities: parsePayload.entities,
                 time: new Date().toISOString()
               };
               if (parsePayload.intent) {
@@ -903,6 +922,7 @@ var Spirits = {
               progress('Added message', 'info', 'ADD_MESSAGE', _message);
             } else {
               messages[index].context = parsePayload.context;
+              messages[index].entities = parsePayload.entities;
               if (parsePayload.intent) {
                 messages[index].intent = parsePayload.intent;
               }
@@ -940,7 +960,7 @@ var Spirits = {
             }
             noNewContext = Object.keys(parsePayload.context).length === 0; // 3. Run the workflow
             progress('Running workflow', 'info', 'SET_PROCESSING', 'system');
-            _context2.next = 43;
+            _context2.next = 44;
             return workflow({
               messages: messages,
               conversation: conversation,
@@ -969,7 +989,7 @@ var Spirits = {
                 return accumulator;
               }, []);
             });
-          case 43:
+          case 44:
             slots = _context2.sent;
             hasNoInstructions = slots.every(function (s) {
               return !s.instructions || Array.isArray(s.instructions) && s.instructions.length === 0;
@@ -977,6 +997,9 @@ var Spirits = {
             hasNoCustomMessage = slots.every(function (s) {
               return !s.message;
             });
+            messagesToTransform = slots.filter(function (s) {
+              return !!s.message && _typeof(s.message) === 'object' && !!s.message.transform;
+            });
             previousLockAttempt = conversation.lockAttempts || 0; // Used to track
             if (hasNoInstructions && noNewContext) {
               conversation = incrementLockAttempt(conversation, config);
@@ -992,20 +1015,20 @@ var Spirits = {
             }
             resettedIntent = false;
             _iterator = _createForOfIteratorHelper(slots);
-            _context2.prev = 50;
+            _context2.prev = 52;
             _iterator.s();
-          case 52:
+          case 54:
             if ((_step = _iterator.n()).done) {
-              _context2.next = 112;
+              _context2.next = 114;
               break;
             }
             _step$value = _step.value, forward = _step$value.forward, forwardNote = _step$value.forwardNote, instructions = _step$value.instructions, removeInstructions = _step$value.removeInstructions, manualMessage = _step$value.message, scheduled = _step$value.scheduled, resetIntent = _step$value.resetIntent, secondsDelay = _step$value.secondsDelay, contextUpsert = _step$value.contextUpsert, anticipate = _step$value.anticipate, slotFollowup = _step$value.followup;
             if (!anticipate) {
-              _context2.next = 67;
+              _context2.next = 69;
               break;
             }
             if (!Array.isArray(anticipate)) {
-              _context2.next = 62;
+              _context2.next = 64;
               break;
             }
             // 'literal' anticipation
@@ -1025,11 +1048,11 @@ var Spirits = {
               slots: _slots,
               map: map
             });
-            _context2.next = 67;
+            _context2.next = 69;
             break;
-          case 62:
+          case 64:
             if (!('yes' in anticipate && 'no' in anticipate && 'did' in anticipate)) {
-              _context2.next = 66;
+              _context2.next = 68;
               break;
             }
             // "did" anticipation
@@ -1041,11 +1064,11 @@ var Spirits = {
               },
               did: anticipate.did
             });
-            _context2.next = 67;
+            _context2.next = 69;
             break;
-          case 66:
+          case 68:
             throw new Error("Invalid anticipate payload \"".concat(JSON.stringify(anticipate), "\""));
-          case 67:
+          case 69:
             if (slotFollowup) {
               followup.push(slotFollowup);
             }
@@ -1093,25 +1116,25 @@ var Spirits = {
 
             // Insert instructions context
             if (!instructions) {
-              _context2.next = 84;
+              _context2.next = 86;
               break;
             }
             if (!(typeof instructions === 'string')) {
-              _context2.next = 74;
+              _context2.next = 76;
               break;
             }
             addInstruction(instructions, previousLockAttempt);
-            _context2.next = 84;
+            _context2.next = 86;
             break;
-          case 74:
+          case 76:
             if (!Array.isArray(instructions)) {
-              _context2.next = 79;
+              _context2.next = 81;
               break;
             }
-            _iterator2 = _createForOfIteratorHelper(instructions);
+            _iterator3 = _createForOfIteratorHelper(instructions);
             try {
-              for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
-                instruction = _step2.value;
+              for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+                instruction = _step3.value;
                 if (typeof instruction === 'string') {
                   addInstruction(instruction, previousLockAttempt);
                 } else {
@@ -1119,35 +1142,35 @@ var Spirits = {
                 }
               }
             } catch (err) {
-              _iterator2.e(err);
+              _iterator3.e(err);
             } finally {
-              _iterator2.f();
+              _iterator3.f();
             }
-            _context2.next = 84;
+            _context2.next = 86;
             break;
-          case 79:
+          case 81:
             if (!(_typeof(instructions) === 'object' && 'content' in instructions)) {
-              _context2.next = 83;
+              _context2.next = 85;
               break;
             }
             addInstruction(instructions.content, previousLockAttempt, instructions.id);
-            _context2.next = 84;
+            _context2.next = 86;
             break;
-          case 83:
+          case 85:
             throw new Error("SpiritsError: instructions must be a string or array or {content: \"<instruction>\"}, got: ".concat(JSON.stringify(instructions)));
-          case 84:
+          case 86:
             if (!removeInstructions) {
-              _context2.next = 101;
+              _context2.next = 103;
               break;
             }
-            _iterator3 = _createForOfIteratorHelper(removeInstructions);
-            _context2.prev = 86;
+            _iterator4 = _createForOfIteratorHelper(removeInstructions);
+            _context2.prev = 88;
             _loop = /*#__PURE__*/_regeneratorRuntime().mark(function _loop() {
               var instructionId, index;
               return _regeneratorRuntime().wrap(function _loop$(_context) {
                 while (1) switch (_context.prev = _context.next) {
                   case 0:
-                    instructionId = _step3.value;
+                    instructionId = _step4.value;
                     index = messages.findIndex(function (m) {
                       return m.id === instructionId;
                     });
@@ -1165,30 +1188,30 @@ var Spirits = {
                 }
               }, _loop);
             });
-            _iterator3.s();
-          case 89:
-            if ((_step3 = _iterator3.n()).done) {
-              _context2.next = 93;
+            _iterator4.s();
+          case 91:
+            if ((_step4 = _iterator4.n()).done) {
+              _context2.next = 95;
               break;
             }
-            return _context2.delegateYield(_loop(), "t0", 91);
-          case 91:
-            _context2.next = 89;
-            break;
+            return _context2.delegateYield(_loop(), "t0", 93);
           case 93:
-            _context2.next = 98;
+            _context2.next = 91;
             break;
           case 95:
-            _context2.prev = 95;
-            _context2.t1 = _context2["catch"](86);
-            _iterator3.e(_context2.t1);
-          case 98:
-            _context2.prev = 98;
-            _iterator3.f();
-            return _context2.finish(98);
-          case 101:
+            _context2.next = 100;
+            break;
+          case 97:
+            _context2.prev = 97;
+            _context2.t1 = _context2["catch"](88);
+            _iterator4.e(_context2.t1);
+          case 100:
+            _context2.prev = 100;
+            _iterator4.f();
+            return _context2.finish(100);
+          case 103:
             if (!manualMessage) {
-              _context2.next = 108;
+              _context2.next = 110;
               break;
             }
             manualMessageObj = {
@@ -1198,11 +1221,11 @@ var Spirits = {
               time: new Date().toISOString()
             };
             if (!(typeof manualMessage !== 'string')) {
-              _context2.next = 105;
+              _context2.next = 107;
               break;
             }
             throw new Error('Manual message must be of type "string"');
-          case 105:
+          case 107:
             if (scheduled) {
               manualMessageObj.time = new Date(scheduled * 1000).toISOString();
               manualMessageObj.scheduled = manualMessageObj.time;
@@ -1214,7 +1237,7 @@ var Spirits = {
             }
             messages.push(manualMessageObj);
             progress('Added manual message', 'info', 'ADD_MESSAGE', messages[messages.length - 1]);
-          case 108:
+          case 110:
             if (contextUpsert) {
               context = updateContext(context, contextUpsert);
               progress('Upserted context', 'info', 'UPDATE_CONTEXT', contextUpsert);
@@ -1222,21 +1245,21 @@ var Spirits = {
             if (resetIntent) {
               resettedIntent = true;
             }
-          case 110:
-            _context2.next = 52;
-            break;
           case 112:
-            _context2.next = 117;
+            _context2.next = 54;
             break;
           case 114:
-            _context2.prev = 114;
-            _context2.t2 = _context2["catch"](50);
+            _context2.next = 119;
+            break;
+          case 116:
+            _context2.prev = 116;
+            _context2.t2 = _context2["catch"](52);
             _iterator.e(_context2.t2);
-          case 117:
-            _context2.prev = 117;
+          case 119:
+            _context2.prev = 119;
             _iterator.f();
-            return _context2.finish(117);
-          case 120:
+            return _context2.finish(119);
+          case 122:
             if (resettedIntent && !_forward) {
               conversation.intent = null;
               conversation.intentScore = null;
@@ -1255,16 +1278,16 @@ var Spirits = {
             // 4. Generate response
             // If conversation previously locked, don't generate
             if (input.conversation.locked) {
-              _context2.next = 135;
+              _context2.next = 170;
               break;
             }
             if (!((!conversation.locked || !hasNoInstructions) && !!hasNoCustomMessage)) {
-              _context2.next = 135;
+              _context2.next = 137;
               break;
             }
-            _context2.prev = 123;
+            _context2.prev = 125;
             progress('Parsing message', 'info', 'SET_PROCESSING', 'system');
-            _context2.next = 127;
+            _context2.next = 129;
             return generator({
               messages: messages,
               persona: persona,
@@ -1272,7 +1295,7 @@ var Spirits = {
               llm: config.llm,
               pmt: config.pmt
             });
-          case 127:
+          case 129:
             generatorPayload = _context2.sent;
             if (!generatorPayload.send) {
               progress('Generated response', 'failed', undefined, {
@@ -1309,14 +1332,86 @@ var Spirits = {
                 }
               }
             }
-            _context2.next = 135;
+            _context2.next = 137;
             break;
-          case 131:
-            _context2.prev = 131;
-            _context2.t3 = _context2["catch"](123);
+          case 133:
+            _context2.prev = 133;
+            _context2.t3 = _context2["catch"](125);
             console.error("Locking conversation, error generating response: ".concat(_context2.t3.message));
             conversation = lockConversation(conversation, 'API: ' + _context2.t3.message);
-          case 135:
+          case 137:
+            if (!(messagesToTransform.length && transformer)) {
+              _context2.next = 169;
+              break;
+            }
+            _context2.prev = 138;
+            _iterator2 = _createForOfIteratorHelper(messagesToTransform);
+            _context2.prev = 140;
+            _iterator2.s();
+          case 142:
+            if ((_step2 = _iterator2.n()).done) {
+              _context2.next = 153;
+              break;
+            }
+            _step2.value;
+            _context2.next = 146;
+            return transformer({
+              message: messagesToTransform,
+              persona: persona,
+              customer: customer.id,
+              messages: messages,
+              context: context
+            });
+          case 146:
+            transformResponse = _context2.sent;
+            progress('Generated response', 'success', undefined, undefined);
+            // Check if already had message
+            _agentMessages = messages.filter(function (m) {
+              return m.role === 'agent';
+            });
+            _lastAgentMessage = _agentMessages[_agentMessages.length - 1];
+            if (_lastAgentMessage && _lastAgentMessage.content === transformResponse.message) {
+              // Error should not have happened
+              conversation = lockConversation(conversation, 'Duplicate message');
+            } else {
+              messages.push({
+                id: idGenerator('agent'),
+                role: 'agent',
+                content: transformResponse.message,
+                time: new Date().toISOString()
+              });
+              progress('Added agent message', 'info', 'ADD_MESSAGE', messages[messages.length - 1]);
+            }
+          case 151:
+            _context2.next = 142;
+            break;
+          case 153:
+            _context2.next = 158;
+            break;
+          case 155:
+            _context2.prev = 155;
+            _context2.t4 = _context2["catch"](140);
+            _iterator2.e(_context2.t4);
+          case 158:
+            _context2.prev = 158;
+            _iterator2.f();
+            return _context2.finish(158);
+          case 161:
+            _context2.next = 167;
+            break;
+          case 163:
+            _context2.prev = 163;
+            _context2.t5 = _context2["catch"](138);
+            console.error("Locking conversation, error transforming response: ".concat(_context2.t5.message));
+            conversation = lockConversation(conversation, 'API: ' + _context2.t5.message);
+          case 167:
+            _context2.next = 170;
+            break;
+          case 169:
+            if (messagesToTransform.length) {
+              console.warn("No transformer provided");
+            }
+          case 170:
             progress('Parsing message', 'info', 'SET_PROCESSING', null);
             return _context2.abrupt("return", {
               conversation: {
@@ -1339,11 +1434,11 @@ var Spirits = {
               },
               followup: followup
             });
-          case 137:
+          case 172:
           case "end":
             return _context2.stop();
         }
-      }, _callee, null, [[50, 114, 117, 120], [86, 95, 98, 101], [123, 131]]);
+      }, _callee, null, [[52, 116, 119, 122], [88, 97, 100, 103], [125, 133], [138, 163], [140, 155, 158, 161]]);
     }));
     function customer(_x) {
       return _customer.apply(this, arguments);

package/dist/spirits.cjs

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var spirits = require("./spirits-2ab4d673.cjs");
+var spirits = require("./spirits-8819b1c9.cjs");
 
 
 

package/dist/testing-tools.cjs

@@ -2,8 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var dev = require("./dev-ccf05f24.cjs");
-require("./spirits-2ab4d673.cjs");
+var dev = require("./dev-32a9a0c8.cjs");
+require("./spirits-8819b1c9.cjs");
 require('util');
 require('stream');
 require('path');
@@ -24,7 +24,7 @@ require('node:url');
 require('node:events');
 require('node:stream');
 require('node:string_decoder');
-require("./macros-f855de63.cjs");
+require("./macros-621210f1.cjs");
 require('node:readline');
 require('node:process');
 require('node:os');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scout9/app",
-  "version": "1.0.0-alpha.0.5.8",
+  "version": "1.0.0-alpha.0.6.0",
   "description": "Build and deploy your Scout9 app for SMS auto replies",
   "publishConfig": {
     "access": "public"
@@ -100,6 +100,7 @@
     "polka": "^0.5.2",
     "sade": "^1.8.1",
     "sirv": "^2.0.4",
+    "ws": "^8.18.0",
     "zod": "^3.22.4",
     "zod-validation-error": "^3.4.0"
   },