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

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

@@ -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-89d0d9da.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-bee5e8fd.js', document.baseURI).href))), 'utf-8');
         case 10:
           _context2.t1 = _context2.sent;
           pkg = _context2.t0.parse.call(_context2.t0, _context2.t1);
@@ -35781,6 +35781,48 @@ function MacroUtilsFactory() {
 }
 var MacroUtils = MacroUtilsFactory();
 
+var MacroGlobals = /*#__PURE__*/function () {
+  function MacroGlobals() {
+    spirits._classCallCheck(this, MacroGlobals);
+  }
+  spirits._createClass(MacroGlobals, null, [{
+    key: "$convo",
+    value:
+    /**
+     * @returns {string}
+     */
+    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)));
+      }
+      if (typeof $convo !== 'string') {
+        throw new Error("$convo not a type string, $convo=".concat(JSON.stringify($convo)));
+      }
+      return $convo;
+    }
+
+    /**
+     * @returns {WorkflowEvent}
+     */
+  }, {
+    key: "event",
+    value: function event() {
+      var event = globalThis === null || globalThis === void 0 ? void 0 : globalThis.SCOUT9;
+      if (!event) {
+        throw new Error("No runtime context, ".concat(spirits._classStaticPrivateFieldSpecGet(MacroGlobals, MacroGlobals, _hint)));
+      }
+      return event;
+    }
+  }]);
+  return MacroGlobals;
+}();
+var _hint = {
+  writable: true,
+  value: "make sure the context is properly instantiated before running workflow."
+};
+
 var _excluded$1 = ["success"];
 
 /**
@@ -35841,6 +35883,23 @@ var _excluded$1 = ["success"];
  * @property {WorkflowResponseSlotBaseWithKeywords[]} withoutCondition.instruction - Array of slots with keywords.
  */
 
+// export type WorkflowResponseSlotBase = {
+//   /** Forward input information of a conversation */
+//   forward?: Forward | undefined;
+//   /** Note to provide to the agent, recommend using forward object api instead */
+//   forwardNote?: string | undefined;
+//   instructions?: Instruction[] | undefined;
+//   removeInstructions?: string[] | undefined;
+//   message?: string | undefined;
+//   secondsDelay?: number | undefined;
+//   scheduled?: number | undefined;
+//   contextUpsert?: {
+//     [x: string]: any;
+// } | undefined;
+// resetIntent?: boolean | undefined;
+// followup?: Followup | undefined;
+// };
+
 /**
  * Event macros to be used inside your scout9 auto reply workflows
  * @typedef {Object} EventMacros
@@ -35853,6 +35912,9 @@ var _excluded$1 = ["success"];
  * @property {function(boolean?): Array<WorkflowResponseSlot>} toJSON
  */
 function EventMacrosFactory() {
+  /**
+   * @type {Array<WorkflowResponseSlot>}
+   */
   var slots = [];
   return {
     /**
@@ -35994,6 +36056,72 @@ function EventMacrosFactory() {
       }
       return this;
     },
+    resetIntent: function resetIntent() {
+      /** @type {WorkflowResponseSlot} */
+      var slot = {
+        resetIntent: true
+      };
+      try {
+        slots.push(macros.WorkflowResponseSlotSchema.parse(slot));
+      } catch (e) {
+        throw simplifyError(e, 'Invalid instruct() input');
+      }
+      return this;
+    },
+    /**
+     * Removes an instruction from the system
+     * @param {string | string[]} idOrIds - the instruction ids to remove
+     * @param {boolean} [strict] - if true, throw error if no id exists
+     */
+    instructRemove: function instructRemove(idOrIds) {
+      var strict = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+      /** @type {WorkflowResponseSlot} */
+      var slot = {};
+      var ids = Array.isArray(idOrIds) ? idOrIds : typeof idOrIds === 'string' ? [idOrIds] : [];
+      if (!ids.length) {
+        throw new Error("Given an empty or invalid value for instructRemove, given: ".concat(JSON.stringify(idOrIds), ", expect a type string or type Array<string>"));
+      }
+      var event = MacroGlobals.event(); // Check the event to eval ids to remove
+      ids.forEach(function (id) {
+        var message = event.messages.find(function (m) {
+          return m.id === id;
+        });
+        if (!message) {
+          var msg = "Cannot remove \"".concat(id, "\", no instruction found");
+          if (strict) {
+            throw new Error(msg);
+          } else {
+            console.warn(msg);
+          }
+        }
+      });
+      slot.removeInstructions = ids;
+      try {
+        slots.push(macros.WorkflowResponseSlotSchema.parse(slot));
+      } catch (e) {
+        throw simplifyError(e, 'Invalid instruct() input');
+      }
+      return this;
+    },
+    /**
+     * If conversation is not stagnant, return instructions to guide next auto reply response, otherwise it will forward the conversation
+     * @param {string} instruction
+     * @param {OptionsInstruct & OptionsForward & {stagnationLimit?: number}} [options] - stagnationCountLimit, defaults to 2
+     * @return {EventMacros}
+     */
+    instructSafe: function instructSafe(instruction) {
+      var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {
+        stagnationLimit: 2
+      };
+      var _options$stagnationLi = options.stagnationLimit,
+        stagnationLimit = _options$stagnationLi === void 0 ? 2 : _options$stagnationLi;
+      var event = MacroGlobals.event(); // Check the event to eval stagnation
+      if (event.stagnationCount < stagnationLimit) {
+        return this.instruct(instruction, options);
+      } else {
+        return this.forward("Instruct Exceeds event.stagnationCount >= ".concat(stagnationLimit, ": ").concat(instruction), options);
+      }
+    },
     /**
      * Return instructions to guide next auto reply response
      * @param {string} instruction
@@ -36110,7 +36238,7 @@ function EventMacrosFactory() {
 var eventMacros = EventMacrosFactory();
 
 /**
- * Return instructions to guide next auto reply response
+ * Return instructions to guide next response
  * @param {string} instruction - the instruction to send to the
  * @param {OptionsInstruct} [options]
  * @return {EventMacros}
@@ -36121,6 +36249,19 @@ var eventMacros = EventMacrosFactory();
  */
 var instruct = eventMacros.instruct.bind(eventMacros);
 
+/**
+ * If conversation is not stagnant, return instructions to guide next auto reply response, otherwise it will forward the conversation
+ * @param {string} instruction - the instruction to send to the
+ * @param {OptionsInstruct} [options]
+ * @return {EventMacros}
+ *
+ * @example instructSafe("Ask user if they are looking to order a pizza");
+ * @example instructSafe("Ask user if they are looking to order a pizza", {stagnationLimit: 3}); // Allows for 3 stagnate messages before forwarding
+ *
+ * @type {(message: string, options?: OptionsInstruct) => EventMacros}
+ */
+var instructSafe = eventMacros.instructSafe.bind(eventMacros);
+
 /**
  * Forwards conversation back to you or owner of workflow.
  *
@@ -42828,6 +42969,7 @@ var Scout9Test = /*#__PURE__*/function () {
 }();
 
 exports.$ = $$1;
+exports.MacroGlobals = MacroGlobals;
 exports.ProgressLogger = ProgressLogger;
 exports.Scout9Test = Scout9Test;
 exports.balancedMatch = balancedMatch;
@@ -42846,6 +42988,7 @@ exports.getAugmentedNamespace = getAugmentedNamespace;
 exports.getDefaultExportFromCjs = getDefaultExportFromCjs;
 exports.globSync = globSync;
 exports.instruct = instruct;
+exports.instructSafe = instructSafe;
 exports.loadConfig = loadConfig;
 exports.loadEnvConfig = loadEnvConfig;
 exports.loadUserPackageJson = loadUserPackageJson;

package/dist/{index-d60f8919.cjs → index-d96ba879.cjs}

@@ -1,7 +1,7 @@
 'use strict';
 
 var spirits = require("./spirits-5c9243a1.cjs");
-var dev = require("./dev-89d0d9da.cjs");
+var dev = require("./dev-bee5e8fd.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-6df56089.cjs"); });
+    } = await Promise.resolve().then(function () { return require("./multipart-parser-f2044b7e.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-d60f8919.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-d96ba879.js', document.baseURI).href))), 'utf-8');
         case 10:
           _context.t1 = _context.sent;
           pkg = _context.t0.parse.call(_context.t0, _context.t1);
@@ -41966,37 +41966,6 @@ var EventResponse = /*#__PURE__*/function () {
   return EventResponse;
 }();
 
-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;
-    }
-  }, {
-    key: "event",
-    value: function event() {
-      var event = globalThis === null || globalThis === void 0 ? void 0 : globalThis.SCOUT9;
-      if (!event) {
-        throw new Error("No runtime context, ".concat(spirits._classStaticPrivateFieldSpecGet(MacroGlobals, MacroGlobals, _hint)));
-      }
-      return event;
-    }
-  }]);
-  return MacroGlobals;
-}();
-var _hint = {
-  writable: true,
-  value: "make sure the context is properly instantiated before running workflow."
-};
-
 var _excluded = ["event"];
 function handleAxiosResponse(res) {
   if (res.status === 200) {
@@ -42045,8 +42014,8 @@ function _did() {
     return spirits._regeneratorRuntime().wrap(function _callee$(_context2) {
       while (1) switch (_context2.prev = _context2.next) {
         case 0:
-          convoId = MacroGlobals.$convo();
-          event = MacroGlobals.event();
+          convoId = dev.MacroGlobals.$convo();
+          event = dev.MacroGlobals.event();
           event.conversation.$id = convoId;
           event.conversation.id = convoId;
           if (convoId) {
@@ -42116,8 +42085,8 @@ function _does() {
       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();
+          convoId = dev.MacroGlobals.$convo();
+          event = dev.MacroGlobals.event();
           event.conversation.$id = convoId;
           event.conversation.id = convoId;
           if (convoId) {
@@ -42159,8 +42128,8 @@ function _context() {
     return spirits._regeneratorRuntime().wrap(function _callee3$(_context4) {
       while (1) switch (_context4.prev = _context4.next) {
         case 0:
-          convoId = MacroGlobals.$convo();
-          event = MacroGlobals.event();
+          convoId = dev.MacroGlobals.$convo();
+          event = dev.MacroGlobals.event();
           event.conversation.$id = convoId;
           event.conversation.id = convoId;
           if (convoId) {
@@ -43188,7 +43157,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-d60f8919.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-d96ba879.js', document.baseURI).href)));
 var __dirname$1 = path__default["default"].dirname(__filename$1);
 function zipDirectory(source, out) {
   var archive = archiver$1('tar', {
@@ -43403,7 +43372,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-d60f8919.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-d96ba879.js', document.baseURI).href))), 'utf-8');
         case 14:
           _context4.t1 = _context4.sent;
           packageTemplate = _context4.t0.parse.call(_context4.t0, _context4.t1);

package/dist/index.cjs

@@ -2,8 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var index = require("./index-d60f8919.cjs");
-var dev = require("./dev-89d0d9da.cjs");
+var index = require("./index-d96ba879.cjs");
+var dev = require("./dev-bee5e8fd.cjs");
 require("./spirits-5c9243a1.cjs");
 require("./macros-e4105c56.cjs");
 require('fs');
@@ -57,4 +57,5 @@ exports.createMockMessage = dev.createMockMessage;
 exports.createMockWorkflowEvent = dev.createMockWorkflowEvent;
 exports.forward = dev.forward;
 exports.instruct = dev.instruct;
+exports.instructSafe = dev.instructSafe;
 exports.reply = dev.reply;

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

@@ -2,9 +2,9 @@
 
 require('node:fs');
 require('node:path');
-var index = require("./index-d60f8919.cjs");
+var index = require("./index-d96ba879.cjs");
 require("./spirits-5c9243a1.cjs");
-require("./dev-89d0d9da.cjs");
+require("./dev-bee5e8fd.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-89d0d9da.cjs");
+var dev = require("./dev-bee5e8fd.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.2",
+  "version": "1.0.0-alpha.0.4.4",
   "description": "Build and deploy your Scout9 app for SMS auto replies",
   "publishConfig": {
     "access": "public"

package/src/runtime/macros/event.js

@@ -1,6 +1,7 @@
 import { WorkflowResponseSlotBaseSchema, WorkflowResponseSlotSchema } from '../schemas/workflow.js';
 import { MacroUtils } from './utils.js';
 import { simplifyError } from '../../utils/index.js';
+import MacroGlobals from './globals.js';
 
 
 /**
@@ -61,6 +62,25 @@ import { simplifyError } from '../../utils/index.js';
  * @property {WorkflowResponseSlotBaseWithKeywords[]} withoutCondition.instruction - Array of slots with keywords.
  */
 
+// export type WorkflowResponseSlotBase = {
+//   /** Forward input information of a conversation */
+//   forward?: Forward | undefined;
+//   /** Note to provide to the agent, recommend using forward object api instead */
+//   forwardNote?: string | undefined;
+//   instructions?: Instruction[] | undefined;
+//   removeInstructions?: string[] | undefined;
+//   message?: string | undefined;
+//   secondsDelay?: number | undefined;
+//   scheduled?: number | undefined;
+//   contextUpsert?: {
+//     [x: string]: any;
+// } | undefined;
+// resetIntent?: boolean | undefined;
+// followup?: Followup | undefined;
+// };
+
+
+
 /**
  * Event macros to be used inside your scout9 auto reply workflows
  * @typedef {Object} EventMacros
@@ -74,6 +94,9 @@ import { simplifyError } from '../../utils/index.js';
  */
 function EventMacrosFactory() {
 
+  /**
+   * @type {Array<WorkflowResponseSlot>}
+   */
   let slots = [];
 
   return {
@@ -214,6 +237,68 @@ function EventMacrosFactory() {
       return this;
     },
 
+    resetIntent() {
+      /** @type {WorkflowResponseSlot} */
+      const slot = {resetIntent: true};
+      try {
+        slots.push(WorkflowResponseSlotSchema.parse(slot));
+      } catch (e) {
+        throw simplifyError(e, 'Invalid instruct() input');
+      }
+      return this;
+    },
+
+    /**
+     * Removes an instruction from the system
+     * @param {string | string[]} idOrIds - the instruction ids to remove
+     * @param {boolean} [strict] - if true, throw error if no id exists
+     */
+    instructRemove(idOrIds, strict = false) {
+      /** @type {WorkflowResponseSlot} */
+      const slot = {};
+      const ids = Array.isArray(idOrIds) ? idOrIds : typeof idOrIds === 'string' ? [idOrIds] : [];
+      if (!ids.length) {
+        throw new Error(`Given an empty or invalid value for instructRemove, given: ${JSON.stringify(idOrIds)}, expect a type string or type Array<string>`);
+      }
+      const event = MacroGlobals.event(); // Check the event to eval ids to remove
+      ids.forEach((id) => {
+        const message = event.messages.find(m => m.id === id);
+        if (!message) {
+          const msg = `Cannot remove "${id}", no instruction found`
+          if (strict) {
+            throw new Error(msg);
+          } else {
+            console.warn(msg);
+          }
+        }
+      });
+      slot.removeInstructions = ids;
+      try {
+        slots.push(WorkflowResponseSlotSchema.parse(slot));
+      } catch (e) {
+        throw simplifyError(e, 'Invalid instruct() input');
+      }
+      return this;
+    },
+
+    /**
+     * If conversation is not stagnant, return instructions to guide next auto reply response, otherwise it will forward the conversation
+     * @param {string} instruction
+     * @param {OptionsInstruct & OptionsForward & {stagnationLimit?: number}} [options] - stagnationCountLimit, defaults to 2
+     * @return {EventMacros}
+     */
+    instructSafe(instruction, options = {stagnationLimit: 2}) {
+      const {stagnationLimit = 2} = options;
+      const event = MacroGlobals.event(); // Check the event to eval stagnation
+      if (event.stagnationCount < stagnationLimit) {
+        return this.instruct(instruction, options);
+      } else {
+        return this.forward(`Instruct Exceeds event.stagnationCount >= ${stagnationLimit}: ${instruction}`, options);
+      }
+    },
+
+
+
     /**
      * Return instructions to guide next auto reply response
      * @param {string} instruction
@@ -327,7 +412,7 @@ function EventMacrosFactory() {
 const eventMacros = EventMacrosFactory();
 
 /**
- * Return instructions to guide next auto reply response
+ * Return instructions to guide next response
  * @param {string} instruction - the instruction to send to the
  * @param {OptionsInstruct} [options]
  * @return {EventMacros}
@@ -338,6 +423,19 @@ const eventMacros = EventMacrosFactory();
  */
 export const instruct = eventMacros.instruct.bind(eventMacros);
 
+/**
+ * If conversation is not stagnant, return instructions to guide next auto reply response, otherwise it will forward the conversation
+ * @param {string} instruction - the instruction to send to the
+ * @param {OptionsInstruct} [options]
+ * @return {EventMacros}
+ *
+ * @example instructSafe("Ask user if they are looking to order a pizza");
+ * @example instructSafe("Ask user if they are looking to order a pizza", {stagnationLimit: 3}); // Allows for 3 stagnate messages before forwarding
+ *
+ * @type {(message: string, options?: OptionsInstruct) => EventMacros}
+ */
+export const instructSafe = eventMacros.instructSafe.bind(eventMacros);
+
 /**
  * Forwards conversation back to you or owner of workflow.
  *

package/src/runtime/macros/globals.js

@@ -2,14 +2,23 @@
 
 export default class MacroGlobals {
 
+  /**
+   * @returns {string}
+   */
   static $convo() {
     const $convo = globalThis?.SCOUT9?.$convo;
     if (!$convo) {
       throw new Error(`$convo not found in runtime context, ${MacroGlobals.#hint}`);
     }
+    if (typeof $convo !== 'string') {
+      throw new Error(`$convo not a type string, $convo=${JSON.stringify($convo)}`);
+    }
     return $convo;
   }
 
+  /**
+   * @returns {WorkflowEvent}
+   */
   static event() {
     const event = globalThis?.SCOUT9;
     if (!event) {