@scout9/app 1.0.0-alpha.0.3.1 → 1.0.0-alpha.0.3.3

package/dist/{index-78f40e9a.cjs → index-c6c0a761.cjs}

@@ -1,8 +1,8 @@
 'use strict';
 
-var spirits = require("./spirits-76855e30.cjs");
-var dev = require("./dev-73437873.cjs");
-var macros = require("./macros-44f1f872.cjs");
+var spirits = require("./spirits-bf93b875.cjs");
+var dev = require("./dev-f7215614.cjs");
+var macros = require("./macros-5be965e9.cjs");
 var require$$0 = require('fs');
 var require$$2$1 = require('events');
 var require$$1 = require('path');
@@ -29483,7 +29483,7 @@ class Body {
     }
     const {
       toFormData
-    } = await Promise.resolve().then(function () { return require("./multipart-parser-12c1b026.cjs"); });
+    } = await Promise.resolve().then(function () { return require("./multipart-parser-734db7f7.cjs"); });
     return toFormData(this.body, ct);
   }
 
@@ -41892,7 +41892,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-78f40e9a.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-c6c0a761.js', document.baseURI).href))), 'utf-8');
         case 10:
           _context.t1 = _context.sent;
           pkg = _context.t0.parse.call(_context.t0, _context.t1);
@@ -43098,7 +43098,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-78f40e9a.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-c6c0a761.js', document.baseURI).href)));
 var __dirname$1 = path__default["default"].dirname(__filename$1);
 function zipDirectory(source, out) {
   var archive = archiver$1('tar', {
@@ -43313,7 +43313,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-78f40e9a.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-c6c0a761.js', document.baseURI).href))), 'utf-8');
         case 14:
           _context4.t1 = _context4.sent;
           packageTemplate = _context4.t0.parse.call(_context4.t0, _context4.t1);
@@ -44428,10 +44428,26 @@ var Scout9Platform = {
           method = request.method;
         var status = response.status,
           data = response.data;
-        console.error(dev.$.red(dev.$.bold("".concat(method, " ").concat(path, " Scout9 ApiError (").concat(status, ")")) + ': ' + JSON.stringify(data)));
-        throw new Error(JSON.stringify(data));
+        switch (path) {
+          case '/v1-parse':
+            console.error(dev.$.red(JSON.stringify(data)));
+            break;
+          default:
+            console.error(dev.$.red(dev.$.bold("".concat(method, " ").concat(path, " Scout9 ApiError (").concat(status, ")")) + ': ' + JSON.stringify(data)));
+        }
+        break;
       case 'SyntaxError':
-        throw error;
+        var message = error.message,
+          cause = error.cause;
+        if (cause) {
+          try {
+            message += "\nCause: ".concat(JSON.stringify(cause));
+          } catch (e) {
+            //
+          }
+        }
+        console.error(dev.$.red(dev.$.bold('SyntaxError') + ": ".concat(message)));
+        break;
       case 'ZodError':
         dev.logUserValidationError(error, error.source || 'src/index.js|ts');
         break;

package/dist/index.cjs

@@ -2,10 +2,10 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var index = require("./index-78f40e9a.cjs");
-var dev = require("./dev-73437873.cjs");
-require("./spirits-76855e30.cjs");
-require("./macros-44f1f872.cjs");
+var index = require("./index-c6c0a761.cjs");
+var dev = require("./dev-f7215614.cjs");
+require("./spirits-bf93b875.cjs");
+require("./macros-5be965e9.cjs");
 require('fs');
 require('events');
 require('path');

package/dist/{macros-44f1f872.cjs → macros-5be965e9.cjs}

@@ -4131,7 +4131,7 @@ var PersonasConfigurationSchema = z.array(PersonaConfigurationSchema);
 var AgentsSchema = z.array(AgentSchema);
 var PersonasSchema = z.array(PersonaSchema);
 
-var ConversationContext = z.record(z.string(), z.any());
+var ConversationContext = z.record(z.union([z.string(), z.number(), z["boolean"](), z["null"](), z.array(z.union([z.string(), z.number(), z["boolean"](), z["null"]()]))]));
 var ConversationAnticipateSchema = z.object({
   type: z["enum"](['did', 'literal', 'context'], {
     description: "Determines the runtime to address the next response"

package/dist/{multipart-parser-12c1b026.cjs → multipart-parser-734db7f7.cjs}

@@ -2,9 +2,9 @@
 
 require('node:fs');
 require('node:path');
-var index = require("./index-78f40e9a.cjs");
-require("./spirits-76855e30.cjs");
-require("./dev-73437873.cjs");
+var index = require("./index-c6c0a761.cjs");
+require("./spirits-bf93b875.cjs");
+require("./dev-f7215614.cjs");
 require('util');
 require('stream');
 require('path');
@@ -25,7 +25,7 @@ require('node:stream');
 require('node:string_decoder');
 require('node:readline');
 require('node:process');
-require("./macros-44f1f872.cjs");
+require("./macros-5be965e9.cjs");
 require('node:os');
 require('fs/promises');
 require('constants');

package/dist/schemas.cjs

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var macros = require("./macros-44f1f872.cjs");
+var macros = require("./macros-5be965e9.cjs");
 
 
 

package/dist/{spirits-76855e30.cjs → spirits-bf93b875.cjs}

@@ -779,14 +779,14 @@ var Spirits = {
             }
             throw new Error("SpiritsError: No agent found in conversation, must define \".$agent\" in the conversation");
           case 13:
-            persona = (config.persona || config.agents).find(function (p) {
+            persona = (config.persona || config.personas || config.agents).find(function (p) {
               return p.id === conversation.$agent;
             });
             if (persona) {
               _context2.next = 18;
               break;
             }
-            if (!(config.persona || config.agents).some(function (a) {
+            if (!(config.persona || config.personas || config.agents).some(function (a) {
               return !a.id;
             })) {
               _context2.next = 17;
@@ -914,11 +914,21 @@ var Spirits = {
               stagnationCount: conversation.lockAttempts || 0
             }).then(function (res) {
               return Array.isArray(res) ? res : [res];
+            }).then(function (slots) {
+              return slots.reduce(function (accumulator, slot) {
+                if ('toJSON' in slot) {
+                  var slotJson = slot.toJSON();
+                  accumulator.push.apply(accumulator, _toConsumableArray(Array.isArray(slotJson) ? slotJson : [slotJson]));
+                } else {
+                  accumulator.push(slot);
+                }
+                return accumulator;
+              }, []);
             });
           case 43:
             slots = _context2.sent;
             hasNoInstructions = slots.every(function (s) {
-              return !s.instructions || Array.isArray(s) && s.instructions.length === 0;
+              return !s.instructions || Array.isArray(s.instructions) && s.instructions.length === 0;
             });
             hasNoCustomMessage = slots.every(function (s) {
               return !s.message;

package/dist/spirits.cjs

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

package/dist/testing-tools.cjs

@@ -2,8 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var dev = require("./dev-73437873.cjs");
-require("./spirits-76855e30.cjs");
+var dev = require("./dev-f7215614.cjs");
+require("./spirits-bf93b875.cjs");
 require('util');
 require('stream');
 require('path');
@@ -26,7 +26,7 @@ require('node:stream');
 require('node:string_decoder');
 require('node:readline');
 require('node:process');
-require("./macros-44f1f872.cjs");
+require("./macros-5be965e9.cjs");
 require('node:os');
 require('fs/promises');
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scout9/app",
-  "version": "1.0.0-alpha.0.3.1",
+  "version": "1.0.0-alpha.0.3.3",
   "description": "Build and deploy your Scout9 app for SMS auto replies",
   "publishConfig": {
     "access": "public"

package/src/core/templates/app.js

@@ -112,7 +112,7 @@ const handleError = (e, res = undefined) => {
 const handleZodError = ({error, res = undefined, code = 500, status, name, bodyLabel = 'Provided Input', body = undefined, action = ''}) => {
   res?.writeHead?.(code, {'Content-Type': 'application/json'});
   if (error instanceof ZodError) {
-    const formattedErrors = JSON.stringify(error.errors, null, 2);
+    const formattedErrors = JSON.stringify(error.format(), null, 2);
     res?.end?.(JSON.stringify({
       status,
       errors: formattedErrors
@@ -224,7 +224,14 @@ app.post(dev ? '/dev/workflow' : '/', async (req, res) => {
   }
   let response;
   try {
-    response = await projectApp(workflowEvent);
+    response = await projectApp(workflowEvent)
+      .then((response) => {
+        if ('toJSON' in response) {
+          return response.toJSON();
+        } else {
+          return response;
+        }
+      })
   } catch (error) {
     error.message = `Workflow Template Runtime Error: ` + error.message;
     handleError(error, res);
@@ -356,13 +363,13 @@ async function runEntityApi(req, res) {
     const response = await api({
       params,
       searchParams: req?.query || {}, body: req?.body || undefined,
-      id: params.id
+      id: params?.id
     });
     if (response instanceof EventResponse || !!response.body) {
       const data = response.body ?? response.data();
       res.writeHead(response.status || 200, {'Content-Type': 'application/json'});
       res.end(JSON.stringify(data));
-      console.log(`${req.method} EntityApi.${params.id}:`);
+      console.log(`${req.method} EntityApi.${lastSegment}:`);
       console.log(colors.grey(JSON.stringify(data)));
     } else {
       throw new Error(`Invalid response: not an EventResponse`);

package/src/platform.js

@@ -219,10 +219,25 @@ export const Scout9Platform = {
         const {request, response} = error;
         const { path, method } = request;
         const {status, data} = response;
-        console.error(colors.red(colors.bold(`${method} ${path} Scout9 ApiError (${status})`) + ': ' + JSON.stringify(data)));
-        throw new Error(JSON.stringify(data));
+        switch (path) {
+          case '/v1-parse':
+            console.error(colors.red(JSON.stringify(data)));
+            break;
+          default:
+            console.error(colors.red(colors.bold(`${method} ${path} Scout9 ApiError (${status})`) + ': ' + JSON.stringify(data)));
+        }
+        break;
       case 'SyntaxError':
-        throw error;
+        let {message, cause} = error;
+        if (cause) {
+          try {
+            message += `\nCause: ${JSON.stringify(cause)}`;
+          } catch (e) {
+            //
+          }
+        }
+        console.error(colors.red(colors.bold('SyntaxError') + `: ${message}`));
+        break;
       case 'ZodError':
         logUserValidationError(error, error.source || 'src/index.js|ts');
         break;

package/src/public.d.ts

@@ -106,6 +106,9 @@ export const instruct: (message: string, options?: OptionsInstruct) => EventMacr
  *
  * Calling this method will lock the conversation and prevent auto replies from being sent to the user.
  *
+ * @example - basic forward
+ * forward()
+ *
  * @example - end of workflow
  * forward("User wants 1 cheese pizza ready for pick");
  *
@@ -117,7 +120,7 @@ export const instruct: (message: string, options?: OptionsInstruct) => EventMacr
  *
  * @type {(message: string, options?: OptionsForward) => EventMacros}
  */
-export const forward: (message: string, options?: OptionsForward) => EventMacros;
+export const forward: (message?: string, options?: OptionsForward) => EventMacros;
 /**
  * Manual message to send to the customer from the workflow.
  *
@@ -177,6 +180,8 @@ export type OptionsForward = {
      * - another phone or email to forward to instead of owner
      */
     to?: string;
+
+    resetIntent?: boolean;
 };
 /**
  * - Extends `WorkflowResponseSlotBase` to include keywords.
@@ -214,8 +219,7 @@ export type ContextExampleWithTrainingData = {
     output: Record<string, any>[];
 }
 
-
-export type ConversationContext = Record<string, any>;
+export type ConversationContext = Record<string, string | number | boolean | null | Array<string | number | boolean | null>>;
 
 export type ContextExamples = (ContextExampleWithTrainingData | ConversationContext)[];
 export type ContextOutput = Record<string, any>;
@@ -525,7 +529,15 @@ export type Scout9ProjectConfig = {
 };
 
 export type Scout9ProjectBuildConfig = Scout9ProjectConfig & {
-    agents: Agent[];
+    agents: AgentsConfiguration;
+    /**
+     * @deprecated use agents
+     */
+    personas?: AgentsConfiguration;
+    /**
+     * @deprecated use agents
+     */
+    persona?: AgentsConfiguration;
     entities: EntityRootProjectConfiguration[];
     workflows: WorkflowConfiguration[];
 };
@@ -576,7 +588,7 @@ export type WorkflowResponseSlot = WorkflowResponseSlotBase & {
     anticipate?: Anticipate | undefined;
 };
 
-export type WorkflowResponse = WorkflowResponseSlot | WorkflowResponseSlot[];
+export type WorkflowResponse = EventMacros | WorkflowResponseSlot | (WorkflowResponseSlot | EventMacros)[];
 
 export type WorkflowFunction = (event: WorkflowEvent) => WorkflowResponse | Promise<WorkflowResponse>;
 

package/src/runtime/macros/event.js

@@ -268,12 +268,13 @@ function EventMacrosFactory() {
     },
     /**
      * Returns event payload
+     * @param {boolean} flush - if true, will reset the data payload
      * @return {Array<WorkflowResponseSlot>}
      */
     toJSON(flush = true) {
       if (flush) {
         const copy = [...slots];
-        slots =[];
+        slots = [];
         return copy;
       } else {
         return slots;

package/src/runtime/schemas/conversation.js

@@ -1,7 +1,17 @@
 import { z } from 'zod';
 import { zId } from './utils.js';
 
-export const ConversationContext = z.record(z.string(), z.any());
+export const ConversationContext = z.record(
+  z.union([
+    z.string(),
+    z.number(),
+    z.boolean(),
+    z.null(),
+    z.array(
+      z.union([z.string(), z.number(), z.boolean(), z.null()])
+    )
+  ])
+);
 
 export const ConversationAnticipateSchema = z.object({
   type: z.enum(['did', 'literal', 'context'], {description: "Determines the runtime to address the next response"}),

package/src/testing-tools/dev.js

@@ -1,5 +1,5 @@
 import { Configuration, Scout9Api } from '@scout9/admin';
-import {grey, italic, bgWhite, black} from 'kleur/colors';
+import { grey, italic, bgWhite, black } from 'kleur/colors';
 import { createMockConversation, createMockWorkflowEvent } from './mocks.js';
 import { loadConfig } from '../core/config/index.js';
 import { requireProjectFile } from '../utils/index.js';
@@ -33,7 +33,7 @@ export class Scout9Test {
   messages;
 
   /**
-   * @type {any}
+   * @type {import('@scout9/app').ConversationContext}
    */
   context;
 
@@ -158,7 +158,7 @@ export class Scout9Test {
 
     // Load app configuration (if not already loaded or override true)
     if (override || !this._project) {
-      this._project = await loadConfig({cwd: this._cwd, src: this._src, mode: this._mode})
+      this._project = await loadConfig({cwd: this._cwd, src: this._src, mode: this._mode});
     }
 
     if (override || !this._api) {
@@ -205,7 +205,7 @@ export class Scout9Test {
       const typeStdout = type ? italic(bgWhite(' ' + black(type) + ' ')) : '';
       const messageStdout = grey(message);
       (console.hasOwnProperty(level) ? console[level] : console.log)(`\t${typeStdout ? typeStdout + ' ' : ''}${messageStdout}`);
-    }
+    };
 
     // If custom logger provided, use it, otherwise use default logger
     let progressInput = typeof progress === 'function' ? progress : defaultProgressLogger;
@@ -215,10 +215,14 @@ export class Scout9Test {
       if (!!progress) {
         progressInput = defaultProgressLogger; // use default logger
       } else {
-        progressInput = () => {}; // use no-op
+        progressInput = () => {
+        }; // use no-op
       }
     }
 
+    /**
+     * @type {import('@scout9/app').Message}
+     */
     const _message = {
       id: 'user_mock_' + Math.random().toString(36).slice(2, 11),
       role: 'customer',
@@ -268,7 +272,7 @@ export class Scout9Test {
         console.error(`Invalid forward result`, result.conversation.forward);
         this.conversation.forwardedTo = 'Invalid Forward';
       }
-      this.conversation.forwarded = new Date().toString();
+      this.conversation.forwarded = new Date().toISOString();
       this.conversation.forwardNote = result.conversation.forwardNote || '';
       this.conversation.locked = true;
       this.conversation.lockedReason = result.conversation.forwardNote ?? ('Forwarded to ' + this.conversation.forwardedTo);
@@ -353,6 +357,16 @@ export class Scout9Test {
     }).then((_res => _res.data));
   }
 
+  /**
+   * @param {Partial<import('@scout9/app').ConversationContext>} ctx
+   */
+  set context(ctx) {
+    this.context = {
+      ...this.context,
+      ...ctx
+    };
+  }
+
   /**
    * @private
    */

package/src/testing-tools/spirits.js

@@ -235,9 +235,9 @@ export const Spirits = {
     if (!conversation.$agent) {
       throw new Error(`SpiritsError: No agent found in conversation, must define ".$agent" in the conversation`);
     }
-    const persona = (config.persona || config.agents).find(p => p.id === conversation.$agent);
+    const persona = (config.persona || config.personas || config.agents).find(p => p.id === conversation.$agent);
     if (!persona) {
-      if ((config.persona || config.agents).some(a => !a.id)) {
+      if ((config.persona || config.personas || config.agents).some(a => !a.id)) {
         throw new Error(`SpiritsError: No persona found ("${conversation.$agent}") in provided config, some persona's did not contain an "id" (Internal Mapping Error)`);
       }
       throw new Error(`SpiritsError: No persona found ("${conversation.$agent}") in provided config`);
@@ -322,6 +322,7 @@ export const Spirits = {
 
     // 3. Run the workflow
     progress('Running workflow', 'info', 'SET_PROCESSING', 'system');
+
     const slots = await workflow({
       messages,
       conversation,
@@ -335,8 +336,18 @@ export const Spirits = {
         initial: conversation.intent || null
       },
       stagnationCount: conversation.lockAttempts || 0
-    }).then((res) => Array.isArray(res) ? res : [res]);
-    const hasNoInstructions = slots.every(s => !s.instructions || (Array.isArray(s) && s.instructions.length === 0));
+    })
+      .then((res) => Array.isArray(res) ? res : [res])
+      .then((slots) => slots.reduce((accumulator, slot) => {
+        if ('toJSON' in slot) {
+          const slotJson = slot.toJSON();
+          accumulator.push(...(Array.isArray(slotJson) ? slotJson : [slotJson]));
+        } else {
+          accumulator.push(slot);
+        }
+        return accumulator;
+      }, []));
+    const hasNoInstructions = slots.every(s => !s.instructions || (Array.isArray(s.instructions) && s.instructions.length === 0));
     const hasNoCustomMessage = slots.every(s => !s.message);
     const previousLockAttempt = conversation.lockAttempts || 0; // Used to track