@scout9/app 1.0.0-alpha.0.1.92 → 1.0.0-alpha.0.1.94

package/dist/index.cjs

@@ -2,8 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var exports$1 = require("./exports-dfabefaf.cjs");
-var spirits = require("./spirits-6a709255.cjs");
+var exports$1 = require("./exports-1f0580dd.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-52e1536f.cjs → multipart-parser-bbe3e14d.cjs}

@@ -2,8 +2,8 @@
 
 require('node:fs');
 require('node:path');
-var exports$1 = require("./exports-dfabefaf.cjs");
-require("./spirits-6a709255.cjs");
+var exports$1 = require("./exports-1f0580dd.cjs");
+require("./spirits-32395ac4.cjs");
 require('node:readline');
 require('fs');
 require('events');

package/dist/{spirits-6a709255.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 = {
@@ -1224,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-6a709255.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-dfabefaf.cjs");
-var spirits = require("./spirits-6a709255.cjs");
+var exports$1 = require("./exports-1f0580dd.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.92",
+  "version": "1.0.0-alpha.0.1.94",
   "description": "Build and deploy your Scout9 app for SMS auto replies",
   "publishConfig": {
     "access": "public"

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.`
   });
 }
+

package/src/runtime/client/workflow.js

@@ -6,15 +6,17 @@ import { agentConfigurationSchema, customerSchema } from './users.js';
 import { MessageSchema } from './message.js';
 
 
-
 /**
  * @typedef {import('zod').infer<typeof WorkflowConfigurationSchema>} IWorkflowConfiguration
  */
 export const WorkflowConfigurationSchema = z.object({
-  entities: z.array(zId('Workflow Folder', z.string()), {description: 'Workflow id association, used to handle route params'})
+  entities: z.array(
+    zId('Workflow Folder', z.string()),
+    {description: 'Workflow id association, used to handle route params'}
+  )
     .min(1, 'Must have at least 1 entity')
     .max(15, 'Cannot have more than 15 entity paths'),
-  entity: zId('Workflow Folder', z.string()),
+  entity: zId('Workflow Folder', z.string())
 });
 
 /**
@@ -29,11 +31,12 @@ export const WorkflowsConfigurationSchema = z.array(WorkflowConfigurationSchema)
 export const ConversationSchema = z.object({
   $agent: zId('Conversation Agent ID', z.string({description: 'Default agent assigned to the conversation(s)'})),
   $customer: zId('Conversation Customer ID', z.string({description: 'Customer this conversation is with'})),
-  initialContexts: z.array(z.string(), {description: 'Initial contexts to load when starting the conversation'}).optional(),
+  initialContexts: z.array(z.string(), {description: 'Initial contexts to load when starting the conversation'})
+    .optional(),
   environment: z.enum(['phone', 'email', 'web']),
   environmentProps: z.object({
     subject: z.string({description: 'HTML Subject of the conversation'}).optional(),
-    platformEmailThreadId: z.string({description: 'Used to sync email messages with the conversation'}).optional(),
+    platformEmailThreadId: z.string({description: 'Used to sync email messages with the conversation'}).optional()
   }).optional(),
   locked: z.boolean({description: 'Whether the conversation is locked or not'}).optional().nullable(),
   lockedReason: z.string({description: 'Why this conversation was locked'}).optional().nullable(),
@@ -42,16 +45,16 @@ export const ConversationSchema = z.object({
   forwarded: z.string({description: 'Datetime ISO 8601 timestamp when persona was forwarded'}).optional().nullable(),
   forwardNote: z.string().optional().nullable(),
   intent: z.string({description: 'Detected intent of conversation'}).optional().nullable(),
-  intentScore: z.number({description: 'Confidence score of the assigned intent'}).optional().nullable(),
+  intentScore: z.number({description: 'Confidence score of the assigned intent'}).optional().nullable()
 });
 
 /**
  * @typedef {import('zod').infer<typeof IntentWorkflowEventSchema>} IIntentWorkflowEvent
  */
 export const IntentWorkflowEventSchema = z.object({
- current: z.string().nullable(),
- flow: z.array(z.string()),
- initial: z.string().nullable()
+  current: z.string().nullable(),
+  flow: z.array(z.string()),
+  initial: z.string().nullable()
 });
 
 /**
@@ -74,7 +77,7 @@ export const WorkflowEventSchema = z.object({
   intent: IntentWorkflowEventSchema,
   stagnationCount: z.number(),
   note: z.string({description: 'Any developer notes to provide'}).optional()
-})
+});
 
 const Primitive = z.union([z.string(), z.number(), z.boolean()]);
 // Assuming ConversationContext is already defined as a Zod schema
@@ -102,29 +105,36 @@ export const ForwardSchema = z.union([
     to: z.string().optional(),
     mode: z.enum(['after-reply', 'immediately']).optional(),
     note: z.string({description: 'Note to provide to the agent'}).optional()
-  }),
+  })
 ], {description: 'Forward input information of a conversation'});
 
 
 /**
  * Instruction object schema used to send context to guide conversations
- * @typedef {import('zod').infer<typeof InstructionSchema>} IInstruction
+ * @typedef {import('zod').infer<typeof InstructionObjectSchema>} IInstruction
  */
-export const InstructionSchema = z.object({
-  id: zId('Instruction ID').describe('Unique ID for the instruction, this is used to remove the instruction later'),
-  content: z.string(),
+export const InstructionObjectSchema = z.object({
+  id: zId('Instruction ID')
+    .describe('Unique ID for the instruction, this is used to remove the instruction later')
+    .optional(),
+  persist: z.boolean()
+    .describe(
+      'if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply')
+    .default(true)
+    .optional(),
+  content: z.string()
 });
 
 /**
  * @typedef {import('zod').infer<typeof WorkflowResponseMessageApiRequest>} IWorkflowResponseMessageApiRequest
  */
-export const WorkflowResponseMessageApiRequest =  z.object({
+export const WorkflowResponseMessageApiRequest = z.object({
   uri: z.string(),
   data: z.any().optional(),
   headers: z.object({
-    [z.string()]: z.string(),
+    [z.string()]: z.string()
   }).optional(),
-  method: z.enum(["GET", "POST", "PUT"]).optional()
+  method: z.enum(['GET', 'POST', 'PUT']).optional()
 });
 
 /**
@@ -168,19 +178,67 @@ export const WorkflowResponseMessageApiResponse = z.union([
 
 /**
  * The workflow response object slot
- * @typedef {import('zod').infer<typeof WorkflowResponseSlotSchema>} IWorkflowResponseSlot
+ * @typedef {import('zod').infer<typeof InstructionSchema>} IInstruction
+ */
+export const InstructionSchema = z.union([z.string(), InstructionObjectSchema, z.array(z.string()), z.array(
+  InstructionObjectSchema)]);
+
+/**
+ * Base follow up schema to follow up with the client
+ * @typedef {import('zod').infer<typeof FollowupBaseSchema>} IFollowupBase
+ */
+export const FollowupBaseSchema = z.object({
+  scheduled: z.number(),
+  cancelIf: ConversationContext.optional(),
+  overrideLock: z.boolean({description: 'This will still run even if the conversation is locked, defaults to false'}).optional()
+});
+
+/**
+ * Data used to automatically follow up with the client in the future
+ * @typedef {import('zod').infer<typeof FollowupSchema>} IFollowup
+ */
+export const FollowupSchema = z.union([
+  FollowupBaseSchema.extend({
+    message: z.string({description: 'Manual message sent to client'}),
+  }),
+  FollowupBaseSchema.extend({
+    instructions: InstructionSchema
+  })
+]);
+
+/**
+ * The workflow response object slot
+ * @typedef {import('zod').infer<typeof WorkflowResponseSlotBaseSchema>} IWorkflowResponseSlotBase
  */
-export const WorkflowResponseSlotSchema = z.object({
+export const WorkflowResponseSlotBaseSchema = z.object({
   forward: ForwardSchema.optional(),
-  forwardNote: z.string({description: 'Note to provide to the agent, recommend using forward object api instead'}).optional(),
-  instructions: z.union([z.string(), InstructionSchema, z.array(z.string()), z.array(InstructionSchema)]).optional(),
+  forwardNote: z.string({description: 'Note to provide to the agent, recommend using forward object api instead'})
+    .optional(),
+  instructions: InstructionSchema.optional(),
   removeInstructions: z.array(z.string()).optional(),
   message: z.string().optional(),
-  // message: WorkflowResponseMessage.optional(),
   secondsDelay: z.number().optional(),
   scheduled: z.number().optional(),
   contextUpsert: ConversationContext.optional(),
   resetIntent: z.boolean().optional(),
+  followup: FollowupSchema.optional()
+});
+
+/**
+ * The workflow response object slot
+ * @typedef {import('zod').infer<typeof WorkflowResponseSlotSchema>} IWorkflowResponseSlot
+ */
+export const WorkflowResponseSlotSchema = WorkflowResponseSlotBaseSchema.extend({
+  anticipate: z.union([
+    z.object({
+      did: z.string({definition: 'The prompt to check if true or false'}),
+      yes: WorkflowResponseSlotBaseSchema,
+      no: WorkflowResponseSlotBaseSchema
+    }),
+    z.array(WorkflowResponseSlotBaseSchema.extend({
+      keywords: z.array(z.string()).min(1).max(20)
+    }))
+  ]).optional()
 });
 
 /**
@@ -199,5 +257,5 @@ export const WorkflowFunctionSchema = z.function()
   .args(WorkflowEventSchema)
   .returns(z.union([
     z.promise(WorkflowResponseSchema),
-    WorkflowResponseSchema,
+    WorkflowResponseSchema
   ]));

package/src/runtime/index.js

@@ -1,2 +1,3 @@
 export * from './entry.js';
 export * from './client/index.js';
+export * from './macros/index.js';

package/src/runtime/macros/builder.js

@@ -0,0 +1,43 @@
+/**
+ * Builder Macros
+ * used to build and guide a application logic in relation to the Scout9 conversation state.
+ */
+import { Configuration, Scout9Api } from '@scout9/admin';
+import MacroGlobals from './globals.js';
+
+function handleAxiosResponse(res) {
+  if (res.status === 200) {
+    return res.data;
+  } else {
+    throw new Error(`${res.status} ${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>}
+ */
+export async function did(prompt) {
+  const convoId = MacroGlobals.$convo();
+  const {value} = (await (new Scout9Api(new Configuration({apiKey: process.env.SCOUT9_API_KEY}))).did({prompt, convoId})
+    .then(handleAxiosResponse));
+  return value;
+}
+
+
+/**
+ * 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>}
+ */
+export async function context(prompt, examples) {
+  const convoId = MacroGlobals.$convo();
+  return (await (new Scout9Api(new Configuration({apiKey: process.env.SCOUT9_API_KEY}))).captureContext({
+    prompt,
+    examples,
+    convoId
+  })
+    .then(handleAxiosResponse));
+}