@scout9/app 1.0.0-alpha.0.1.91 → 1.0.0-alpha.0.1.93

package/dist/index.cjs

@@ -2,8 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var exports$1 = require("./exports-212ef6be.cjs");
-var spirits = require("./spirits-3b603262.cjs");
+var exports$1 = require("./exports-83755281.cjs");
+var spirits = require("./spirits-32395ac4.cjs");
 require('node:readline');
 require('fs');
 require('events');
@@ -37,12 +37,115 @@ require('node:util');
 require('node:net');
 require('node:vm');
 
+var MacroGlobals = /*#__PURE__*/function () {
+  function MacroGlobals() {
+    spirits._classCallCheck(this, MacroGlobals);
+  }
+  spirits._createClass(MacroGlobals, null, [{
+    key: "$convo",
+    value: function $convo() {
+      var _globalThis$SCOUT;
+      var $convo = globalThis === null || globalThis === void 0 || (_globalThis$SCOUT = globalThis.SCOUT9) === null || _globalThis$SCOUT === void 0 ? void 0 : _globalThis$SCOUT.$convo;
+      if (!$convo) {
+        throw new Error("$convo not found in runtime context, ".concat(spirits._classStaticPrivateFieldSpecGet(MacroGlobals, MacroGlobals, _hint)));
+      }
+      return $convo;
+    }
+  }]);
+  return MacroGlobals;
+}();
+var _hint = {
+  writable: true,
+  value: "make sure the context is properly instantiated before running workflow."
+};
 
+function handleAxiosResponse(res) {
+  if (res.status === 200) {
+    return res.data;
+  } else {
+    throw new Error("".concat(res.status, " ").concat(res.statusText));
+  }
+}
 
+/**
+ * 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
+ * @return {Promise<boolean>}
+ */
+function did(_x) {
+  return _did.apply(this, arguments);
+}
+
+/**
+ * The `context` macro, similar to the `did` macro, takes a natural statement and checks the entire conversation state and extracts or infers a metadata composition result.
+ * @param {string} prompt
+ * @param {import('@scout9/admin').CaptureContextRequestExamples} [examples]
+ * @return {Promise<import('@scout9/admin').CaptureContext200Response>}
+ */
+function _did() {
+  _did = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee(prompt) {
+    var convoId, _yield$Scout9Api$did$, value;
+    return spirits._regeneratorRuntime().wrap(function _callee$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          convoId = MacroGlobals.$convo();
+          _context2.next = 3;
+          return new exports$1.build.Scout9Api(new exports$1.build.Configuration({
+            apiKey: process.env.SCOUT9_API_KEY
+          })).did({
+            prompt: prompt,
+            convoId: convoId
+          }).then(handleAxiosResponse);
+        case 3:
+          _yield$Scout9Api$did$ = _context2.sent;
+          value = _yield$Scout9Api$did$.value;
+          return _context2.abrupt("return", value);
+        case 6:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee);
+  }));
+  return _did.apply(this, arguments);
+}
+function context(_x2, _x3) {
+  return _context.apply(this, arguments);
+}
+function _context() {
+  _context = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee2(prompt, examples) {
+    var convoId;
+    return spirits._regeneratorRuntime().wrap(function _callee2$(_context3) {
+      while (1) switch (_context3.prev = _context3.next) {
+        case 0:
+          convoId = MacroGlobals.$convo();
+          _context3.next = 3;
+          return new exports$1.build.Scout9Api(new exports$1.build.Configuration({
+            apiKey: process.env.SCOUT9_API_KEY
+          })).captureContext({
+            prompt: prompt,
+            examples: examples,
+            convoId: convoId
+          }).then(handleAxiosResponse);
+        case 3:
+          return _context3.abrupt("return", _context3.sent);
+        case 4:
+        case "end":
+          return _context3.stop();
+      }
+    }, _callee2);
+  }));
+  return _context.apply(this, arguments);
+}
+
+exports.ContextExampleSchema = exports$1.ContextExampleSchema;
+exports.ContextExampleWithTrainingDataSchema = exports$1.ContextExampleWithTrainingDataSchema;
 exports.ConversationContext = exports$1.ConversationContext;
 exports.ConversationSchema = exports$1.ConversationSchema;
 exports.EventResponse = exports$1.EventResponse;
+exports.FollowupBaseSchema = exports$1.FollowupBaseSchema;
+exports.FollowupSchema = exports$1.FollowupSchema;
 exports.ForwardSchema = exports$1.ForwardSchema;
+exports.InstructionObjectSchema = exports$1.InstructionObjectSchema;
 exports.InstructionSchema = exports$1.InstructionSchema;
 exports.IntentWorkflowEventSchema = exports$1.IntentWorkflowEventSchema;
 exports.MessageSchema = exports$1.MessageSchema;
@@ -56,6 +159,7 @@ exports.WorkflowResponseMessage = exports$1.WorkflowResponseMessage;
 exports.WorkflowResponseMessageApiRequest = exports$1.WorkflowResponseMessageApiRequest;
 exports.WorkflowResponseMessageApiResponse = exports$1.WorkflowResponseMessageApiResponse;
 exports.WorkflowResponseSchema = exports$1.WorkflowResponseSchema;
+exports.WorkflowResponseSlotBaseSchema = exports$1.WorkflowResponseSlotBaseSchema;
 exports.WorkflowResponseSlotSchema = exports$1.WorkflowResponseSlotSchema;
 exports.WorkflowsConfigurationSchema = exports$1.WorkflowsConfigurationSchema;
 exports.agentBaseConfigurationSchema = exports$1.agentBaseConfigurationSchema;
@@ -77,12 +181,17 @@ exports.entityApiConfigurationSchema = exports$1.entityApiConfigurationSchema;
 exports.entityConfigurationSchema = exports$1.entityConfigurationSchema;
 exports.entityRootProjectConfigurationSchema = exports$1.entityRootProjectConfigurationSchema;
 exports.eventResponseSchema = exports$1.eventResponseSchema;
+exports.forward = exports$1.forward;
 exports.getApiFunctionSchema = exports$1.getApiFunctionSchema;
+exports.instruct = exports$1.instruct;
 exports.json = exports$1.json;
 exports.patchApiFunctionSchema = exports$1.patchApiFunctionSchema;
 exports.postApiFunctionSchema = exports$1.postApiFunctionSchema;
 exports.putApiFunctionSchema = exports$1.putApiFunctionSchema;
 exports.queryApiFunctionSchema = exports$1.queryApiFunctionSchema;
+exports.reply = exports$1.reply;
 exports.run = exports$1.run;
 exports.sendEvent = exports$1.sendEvent;
 exports.Spirits = spirits.Spirits;
+exports.context = context;
+exports.did = did;

package/dist/{multipart-parser-54a3ab5f.cjs → multipart-parser-af15f044.cjs}

@@ -2,8 +2,8 @@
 
 require('node:fs');
 require('node:path');
-var exports$1 = require("./exports-212ef6be.cjs");
-require("./spirits-3b603262.cjs");
+var exports$1 = require("./exports-83755281.cjs");
+require("./spirits-32395ac4.cjs");
 require('node:readline');
 require('fs');
 require('events');

package/dist/{spirits-3b603262.cjs → spirits-32395ac4.cjs}

@@ -550,6 +550,27 @@ function _createForOfIteratorHelper(o, allowArrayLike) {
     }
   };
 }
+function _classStaticPrivateFieldSpecGet(receiver, classConstructor, descriptor) {
+  _classCheckPrivateStaticAccess(receiver, classConstructor);
+  _classCheckPrivateStaticFieldDescriptor(descriptor, "get");
+  return _classApplyDescriptorGet(receiver, descriptor);
+}
+function _classApplyDescriptorGet(receiver, descriptor) {
+  if (descriptor.get) {
+    return descriptor.get.call(receiver);
+  }
+  return descriptor.value;
+}
+function _classCheckPrivateStaticAccess(receiver, classConstructor) {
+  if (receiver !== classConstructor) {
+    throw new TypeError("Private static access of wrong provenance");
+  }
+}
+function _classCheckPrivateStaticFieldDescriptor(descriptor, action) {
+  if (descriptor === undefined) {
+    throw new TypeError("attempted to " + action + " private static field before its declaration");
+  }
+}
 
 /**
  * @typedef {Object} Document
@@ -644,7 +665,7 @@ function _createForOfIteratorHelper(o, allowArrayLike) {
  * @typedef {Object} ConversationEvent
  * @property {Change<import('../runtime/client/workflow.js').IConversation> & {forwardNote?: string; forward?: import('../runtime/client/message.js').IWorkflowResponseSlot['forward']}} conversation
  * @property {Change<Array<import('../runtime/client/message.js').IMessage>>} messages
- * @property {Change<Object>} context
+ * @property {Change<any>} context
  * @property {Change<import('../runtime/client/message.js').IMessage>} message
  */
 var Spirits = {
@@ -753,38 +774,46 @@ var Spirits = {
               _context2.next = 12;
               break;
             }
-            throw new Error("No agent found in conversation, must define \".$agent\" in the conversation");
+            throw new Error("SpiritsError: No agent found in conversation, must define \".$agent\" in the conversation");
           case 12:
             persona = (config.persona || config.agents).find(function (p) {
               return p.id === conversation.$agent;
             });
             if (persona) {
-              _context2.next = 15;
+              _context2.next = 17;
+              break;
+            }
+            if (!(config.persona || config.agents).some(function (a) {
+              return !a.id;
+            })) {
+              _context2.next = 16;
               break;
             }
-            throw new Error("No persona found (\"".concat(conversation.$agent, "\") in provided config"));
-          case 15:
+            throw new Error("SpiritsError: No persona found (\"".concat(conversation.$agent, "\") in provided config, some persona's did not contain an \"id\" (Internal Mapping Error)"));
+          case 16:
+            throw new Error("SpiritsError: No persona found (\"".concat(conversation.$agent, "\") in provided config"));
+          case 17:
             if (messages.every(function (m) {
               return !!m.id;
             })) {
-              _context2.next = 17;
+              _context2.next = 19;
               break;
             }
-            throw new Error("Every message must have an \".id\", ensure all messages have an id assigned before running");
-          case 17:
+            throw new Error("SpiritsError: Every message must have an \".id\", ensure all messages have an id assigned before running");
+          case 19:
             if (messages.every(function (m) {
               return m.role === 'customer' || m.role === 'agent' || m.role === 'system';
             })) {
-              _context2.next = 20;
+              _context2.next = 22;
               break;
             }
             invalidRoles = messages.filter(function (m) {
               return m.role !== 'customer' && m.role !== 'agent' && m.role !== 'system';
             });
-            throw new Error("Every message must have a role of \"customer\", \"agent\", or \"system\". Got invalid roles: ".concat(invalidRoles.map(function (m) {
+            throw new Error("SpiritsError: Every message must have a role of \"customer\", \"agent\", or \"system\". Got invalid roles: ".concat(invalidRoles.map(function (m) {
               return m.role;
             }).join(', ')));
-          case 20:
+          case 22:
             // if message is not in messages, then add it
             if (!messages.find(function (m) {
               return m.id === input.message.id;
@@ -794,9 +823,9 @@ var Spirits = {
 
             // 2. Parse the message
             progress('Parsing message', 'info', 'SET_PROCESSING', 'user');
-            _context2.next = 24;
+            _context2.next = 26;
             return parser(message.content, 'en');
-          case 24:
+          case 26:
             parsePayload = _context2.sent;
             if (parsePayload.intent) {
               message.intent = parsePayload.intent;
@@ -864,7 +893,7 @@ var Spirits = {
             }
             noNewContext = Object.keys(parsePayload.context).length === 0; // 3. Run the workflow
             progress('Running workflow', 'info', 'SET_PROCESSING', 'system');
-            _context2.next = 40;
+            _context2.next = 42;
             return workflow({
               messages: messages,
               conversation: conversation,
@@ -883,7 +912,7 @@ var Spirits = {
             }).then(function (res) {
               return Array.isArray(res) ? res : [res];
             });
-          case 40:
+          case 42:
             slots = _context2.sent;
             hasNoInstructions = slots.every(function (s) {
               return !s.instructions || Array.isArray(s) && s.instructions.length === 0;
@@ -906,11 +935,11 @@ var Spirits = {
             }
             resettedIntent = false;
             _iterator = _createForOfIteratorHelper(slots);
-            _context2.prev = 47;
+            _context2.prev = 49;
             _iterator.s();
-          case 49:
+          case 51:
             if ((_step = _iterator.n()).done) {
-              _context2.next = 89;
+              _context2.next = 97;
               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;
@@ -957,19 +986,19 @@ var Spirits = {
 
             // Insert instructions context
             if (!instructions) {
-              _context2.next = 67;
+              _context2.next = 69;
               break;
             }
             if (!(typeof instructions === 'string')) {
-              _context2.next = 57;
+              _context2.next = 59;
               break;
             }
             addInstruction(instructions, previousLockAttempt);
-            _context2.next = 67;
+            _context2.next = 69;
             break;
-          case 57:
+          case 59:
             if (!Array.isArray(instructions)) {
-              _context2.next = 62;
+              _context2.next = 64;
               break;
             }
             _iterator2 = _createForOfIteratorHelper(instructions);
@@ -987,25 +1016,25 @@ var Spirits = {
             } finally {
               _iterator2.f();
             }
-            _context2.next = 67;
+            _context2.next = 69;
             break;
-          case 62:
+          case 64:
             if (!(_typeof(instructions) === 'object' && 'content' in instructions && 'id' in instructions)) {
-              _context2.next = 66;
+              _context2.next = 68;
               break;
             }
             addInstruction(instructions.content, previousLockAttempt, instructions.id);
-            _context2.next = 67;
+            _context2.next = 69;
             break;
-          case 66:
-            throw new Error('instructions must be a string or array or {content: "", id: ""}');
-          case 67:
+          case 68:
+            throw new Error('SpiritsError: instructions must be a string or array or {content: "", id: ""}');
+          case 69:
             if (!removeInstructions) {
-              _context2.next = 84;
+              _context2.next = 86;
               break;
             }
             _iterator3 = _createForOfIteratorHelper(removeInstructions);
-            _context2.prev = 69;
+            _context2.prev = 71;
             _loop = /*#__PURE__*/_regeneratorRuntime().mark(function _loop() {
               var instructionId, index;
               return _regeneratorRuntime().wrap(function _loop$(_context) {
@@ -1028,46 +1057,55 @@ var Spirits = {
               }, _loop);
             });
             _iterator3.s();
-          case 72:
+          case 74:
             if ((_step3 = _iterator3.n()).done) {
-              _context2.next = 76;
+              _context2.next = 78;
               break;
             }
-            return _context2.delegateYield(_loop(), "t0", 74);
-          case 74:
-            _context2.next = 72;
-            break;
+            return _context2.delegateYield(_loop(), "t0", 76);
           case 76:
-            _context2.next = 81;
+            _context2.next = 74;
             break;
           case 78:
-            _context2.prev = 78;
-            _context2.t1 = _context2["catch"](69);
+            _context2.next = 83;
+            break;
+          case 80:
+            _context2.prev = 80;
+            _context2.t1 = _context2["catch"](71);
             _iterator3.e(_context2.t1);
-          case 81:
-            _context2.prev = 81;
+          case 83:
+            _context2.prev = 83;
             _iterator3.f();
-            return _context2.finish(81);
-          case 84:
-            if (manualMessage) {
-              manualMessageObj = {
-                id: idGenerator('agent'),
-                role: 'agent',
-                content: message,
-                time: new Date().toISOString()
-              };
-              if (scheduled) {
-                manualMessageObj.time = new Date(scheduled * 1000).toISOString();
-                manualMessageObj.scheduled = manualMessageObj.time;
-              } else if (secondsDelay) {
-                now = new Date();
-                now.setSeconds(now.getSeconds() + secondsDelay);
-                manualMessageObj.time = now.toISOString();
-                manualMessageObj.delayInSeconds = secondsDelay;
-              }
-              messages.push(manualMessageObj);
-              progress('Added manual message', 'info', 'ADD_MESSAGE', messages[messages.length - 1]);
+            return _context2.finish(83);
+          case 86:
+            if (!manualMessage) {
+              _context2.next = 93;
+              break;
+            }
+            manualMessageObj = {
+              id: idGenerator('agent'),
+              role: 'agent',
+              content: manualMessage,
+              time: new Date().toISOString()
+            };
+            if (!(typeof manualMessage !== 'string')) {
+              _context2.next = 90;
+              break;
+            }
+            throw new Error('Manual message must be of type "string"');
+          case 90:
+            if (scheduled) {
+              manualMessageObj.time = new Date(scheduled * 1000).toISOString();
+              manualMessageObj.scheduled = manualMessageObj.time;
+            } else if (secondsDelay) {
+              now = new Date();
+              now.setSeconds(now.getSeconds() + secondsDelay);
+              manualMessageObj.time = now.toISOString();
+              manualMessageObj.delayInSeconds = secondsDelay;
             }
+            messages.push(manualMessageObj);
+            progress('Added manual message', 'info', 'ADD_MESSAGE', messages[messages.length - 1]);
+          case 93:
             if (contextUpsert) {
               context = updateContext(context, contextUpsert);
               progress('Upserted context', 'info', 'UPDATE_CONTEXT', contextUpsert);
@@ -1075,21 +1113,21 @@ var Spirits = {
             if (resetIntent) {
               resettedIntent = true;
             }
-          case 87:
-            _context2.next = 49;
+          case 95:
+            _context2.next = 51;
             break;
-          case 89:
-            _context2.next = 94;
+          case 97:
+            _context2.next = 102;
             break;
-          case 91:
-            _context2.prev = 91;
-            _context2.t2 = _context2["catch"](47);
+          case 99:
+            _context2.prev = 99;
+            _context2.t2 = _context2["catch"](49);
             _iterator.e(_context2.t2);
-          case 94:
-            _context2.prev = 94;
+          case 102:
+            _context2.prev = 102;
             _iterator.f();
-            return _context2.finish(94);
-          case 97:
+            return _context2.finish(102);
+          case 105:
             if (resettedIntent && !_forward) {
               conversation.intent = null;
               conversation.intentScore = null;
@@ -1108,16 +1146,16 @@ var Spirits = {
             // 4. Generate response
             // If conversation previously locked, don't generate
             if (input.conversation.locked) {
-              _context2.next = 112;
+              _context2.next = 120;
               break;
             }
             if (!((!conversation.locked || !hasNoInstructions) && !!hasNoCustomMessage)) {
-              _context2.next = 112;
+              _context2.next = 120;
               break;
             }
-            _context2.prev = 100;
+            _context2.prev = 108;
             progress('Parsing message', 'info', 'SET_PROCESSING', 'system');
-            _context2.next = 104;
+            _context2.next = 112;
             return generator({
               messages: messages,
               persona: persona,
@@ -1125,7 +1163,7 @@ var Spirits = {
               llm: config.llm,
               pmt: config.pmt
             });
-          case 104:
+          case 112:
             generatorPayload = _context2.sent;
             if (!generatorPayload.send) {
               progress('Generated response', 'failed', undefined, {
@@ -1162,14 +1200,14 @@ var Spirits = {
                 }
               }
             }
-            _context2.next = 112;
+            _context2.next = 120;
             break;
-          case 108:
-            _context2.prev = 108;
-            _context2.t3 = _context2["catch"](100);
+          case 116:
+            _context2.prev = 116;
+            _context2.t3 = _context2["catch"](108);
             console.error("Locking conversation, error generating response: ".concat(_context2.t3.message));
             conversation = lockConversation(conversation, 'API: ' + _context2.t3.message);
-          case 112:
+          case 120:
             progress('Parsing message', 'info', 'SET_PROCESSING', null);
             return _context2.abrupt("return", {
               conversation: {
@@ -1191,11 +1229,11 @@ var Spirits = {
                 after: context
               }
             });
-          case 114:
+          case 122:
           case "end":
             return _context2.stop();
         }
-      }, _callee, null, [[47, 91, 94, 97], [69, 78, 81, 84], [100, 108]]);
+      }, _callee, null, [[49, 99, 102, 105], [71, 80, 83, 86], [108, 116]]);
     }));
     function customer(_x) {
       return _customer.apply(this, arguments);
@@ -1207,6 +1245,7 @@ var Spirits = {
 exports.Spirits = Spirits;
 exports._asyncToGenerator = _asyncToGenerator;
 exports._classCallCheck = _classCallCheck;
+exports._classStaticPrivateFieldSpecGet = _classStaticPrivateFieldSpecGet;
 exports._createClass = _createClass;
 exports._createForOfIteratorHelper = _createForOfIteratorHelper;
 exports._defineProperty = _defineProperty;

package/dist/spirits.cjs

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var spirits = require("./spirits-3b603262.cjs");
+var spirits = require("./spirits-32395ac4.cjs");
 
 
 

package/dist/testing-tools.cjs

@@ -2,8 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var exports$1 = require("./exports-212ef6be.cjs");
-var spirits = require("./spirits-3b603262.cjs");
+var exports$1 = require("./exports-83755281.cjs");
+var spirits = require("./spirits-32395ac4.cjs");
 require('node:readline');
 require('fs');
 require('events');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scout9/app",
-  "version": "1.0.0-alpha.0.1.91",
+  "version": "1.0.0-alpha.0.1.93",
   "description": "Build and deploy your Scout9 app for SMS auto replies",
   "publishConfig": {
     "access": "public"
@@ -21,7 +21,7 @@
     "generate:types": "node scripts/generate-dts.js",
     "prebuild": "rimraf dist/",
     "build": "rollup -c",
-    "postbuild": "npm run generate:types && node scripts/post-build.js && npx tsc --noEmit && npm run test",
+    "postbuild": "npm run generate:types && node scripts/post-build.js && npx tsc --noEmit",
     "build-no-test": "npm run prebuild && rollup -c"
   },
   "type": "module",

package/src/core/config/agents.js

@@ -135,7 +135,7 @@ export default async function loadAgentConfig({
     }
     if (!agent.programmablePhoneNumber) {
       const userName = agent.firstName ? `${agent.firstName}${agent.lastName ? ' ' + agent.lastName : ''}` : agent.forwardPhone;
-      cb(`⚠️${colors.yellow('Warning')}: ${userName} does not have a masked phone number to do auto replies. You can register one at ${colors.cyan(
+      cb(`⚠️${colors.yellow('Warning')}: ${userName} does not have a masked phone number to do auto replies.\nYou can register one at ${colors.cyan(
         'https://scout9.com/b')} under ${colors.green('users')} > ${colors.green(userName)}. Then run ${colors.cyan(
         'scout9 sync')} to update.`);
     }

package/src/exports.js

@@ -5,6 +5,7 @@ export { EventResponse } from './runtime/index.js';
 
 export * from './testing-tools/index.js';
 export * from './runtime/client/index.js';
+export * from './runtime/macros/index.js';
 
 /**
  * @param {import('./runtime/client/workflow.js').IWorkflowEvent} event - every workflow receives an event object

package/src/runtime/client/utils.js

@@ -10,3 +10,4 @@ export function zId(name, props = {}) {
     message: `Invalid ${name} ID: ID must not contain spaces and should only contain alphanumeric characters, dashes, or underscores.`
   });
 }
+