@scout9/app 1.0.0-alpha.0.4.3 → 1.0.0-alpha.0.4.5

package/dist/{dev-195686a8.cjs → dev-c50734b5.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-195686a8.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-c50734b5.js', document.baseURI).href))), 'utf-8');
         case 10:
           _context2.t1 = _context2.sent;
           pkg = _context2.t0.parse.call(_context2.t0, _context2.t1);
@@ -35787,14 +35787,25 @@ var MacroGlobals = /*#__PURE__*/function () {
   }
   spirits._createClass(MacroGlobals, null, [{
     key: "$convo",
-    value: function $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() {
@@ -35872,18 +35883,41 @@ 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
  * @property {function(Record<string, any>): EventMacros} upsert
  * @property {function(string, (Date | string | OptionsFollowup)): EventMacros} followup
  * @property {AnticipateFunction} anticipate
+ * @property {function(): EventMacros} resetIntent
+ * @property {function(string | string[], boolean?): EventMacros} instructRemove
+ * @property {function(string, (OptionsInstruct & OptionsForward & {stagnationLimit?: number})?): EventMacros} instructSafe
  * @property {function(string, OptionsInstruct?): EventMacros} instruct
  * @property {function(string, OptionsReply?): EventMacros} reply
  * @property {function(string?, OptionsForward?): EventMacros} forward
  * @property {function(boolean?): Array<WorkflowResponseSlot>} toJSON
  */
 function EventMacrosFactory() {
+  /**
+   * @type {Array<WorkflowResponseSlot>}
+   */
   var slots = [];
   return {
     /**
@@ -36025,6 +36059,53 @@ 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

package/dist/{index-ec0cd08d.cjs → index-e34c4224.cjs}

@@ -1,7 +1,7 @@
 'use strict';
 
 var spirits = require("./spirits-5c9243a1.cjs");
-var dev = require("./dev-195686a8.cjs");
+var dev = require("./dev-c50734b5.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-a2f207ea.cjs"); });
+    } = await Promise.resolve().then(function () { return require("./multipart-parser-cb97a19f.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-ec0cd08d.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-e34c4224.js', document.baseURI).href))), 'utf-8');
         case 10:
           _context.t1 = _context.sent;
           pkg = _context.t0.parse.call(_context.t0, _context.t1);
@@ -43157,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-ec0cd08d.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-e34c4224.js', document.baseURI).href)));
 var __dirname$1 = path__default["default"].dirname(__filename$1);
 function zipDirectory(source, out) {
   var archive = archiver$1('tar', {
@@ -43372,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-ec0cd08d.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-e34c4224.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-ec0cd08d.cjs");
-var dev = require("./dev-195686a8.cjs");
+var index = require("./index-e34c4224.cjs");
+var dev = require("./dev-c50734b5.cjs");
 require("./spirits-5c9243a1.cjs");
 require("./macros-e4105c56.cjs");
 require('fs');

package/dist/{multipart-parser-a2f207ea.cjs → multipart-parser-cb97a19f.cjs}

@@ -2,9 +2,9 @@
 
 require('node:fs');
 require('node:path');
-var index = require("./index-ec0cd08d.cjs");
+var index = require("./index-e34c4224.cjs");
 require("./spirits-5c9243a1.cjs");
-require("./dev-195686a8.cjs");
+require("./dev-c50734b5.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-195686a8.cjs");
+var dev = require("./dev-c50734b5.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.3",
+  "version": "1.0.0-alpha.0.4.5",
   "description": "Build and deploy your Scout9 app for SMS auto replies",
   "publishConfig": {
     "access": "public"

package/src/runtime/macros/event.js

@@ -62,12 +62,33 @@ import MacroGlobals from './globals.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
  * @property {function(Record<string, any>): EventMacros} upsert
  * @property {function(string, (Date | string | OptionsFollowup)): EventMacros} followup
  * @property {AnticipateFunction} anticipate
+ * @property {function(): EventMacros} resetIntent
+ * @property {function(string | string[], boolean?): EventMacros} instructRemove
+ * @property {function(string, (OptionsInstruct & OptionsForward & {stagnationLimit?: number})?): EventMacros} instructSafe
  * @property {function(string, OptionsInstruct?): EventMacros} instruct
  * @property {function(string, OptionsReply?): EventMacros} reply
  * @property {function(string?, OptionsForward?): EventMacros} forward
@@ -75,6 +96,9 @@ import MacroGlobals from './globals.js';
  */
 function EventMacrosFactory() {
 
+  /**
+   * @type {Array<WorkflowResponseSlot>}
+   */
   let slots = [];
 
   return {
@@ -215,6 +239,50 @@ 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
@@ -231,6 +299,7 @@ function EventMacrosFactory() {
       }
     },
 
+
     /**
      * Return instructions to guide next auto reply response
      * @param {string} instruction
@@ -260,6 +329,7 @@ function EventMacrosFactory() {
       }
       return this;
     },
+
     /**
      * If a manual message must be sent, you can use the `reply` macro
      * @param {string} message - the message to manually send to the user
@@ -289,6 +359,7 @@ function EventMacrosFactory() {
       }
       return this;
     },
+
     /**
      * This macro ends the conversation and forwards it the owner of the persona to manually handle the flow. If your app returns undefined or no event, then a default forward is generated.
      * @param {string} [message] - the message to forward to owner of persona
@@ -324,6 +395,7 @@ function EventMacrosFactory() {
       }
       return this;
     },
+
     /**
      * Returns event payload
      * @param {boolean} flush - if true, will reset the data payload

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) {