@scout9/app 1.0.0-alpha.0.1.86 → 1.0.0-alpha.0.1.87

package/dist/{exports-291eb22e.cjs → exports-85e8c05c.cjs}

@@ -41174,7 +41174,7 @@ class Body {
     }
     const {
       toFormData
-    } = await Promise.resolve().then(function () { return require("./multipart-parser-caa634a9.cjs"); });
+    } = await Promise.resolve().then(function () { return require("./multipart-parser-1f8d78d0.cjs"); });
     return toFormData(this.body, ct);
   }
 
@@ -81230,7 +81230,7 @@ function _loadUserPackageJson$1() {
           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('exports-291eb22e.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('exports-85e8c05c.js', document.baseURI).href))), 'utf-8');
         case 10:
           _context2.t1 = _context2.sent;
           pkg = _context2.t0.parse.call(_context2.t0, _context2.t1);
@@ -82075,7 +82075,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('exports-291eb22e.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('exports-85e8c05c.js', document.baseURI).href))), 'utf-8');
         case 10:
           _context.t1 = _context.sent;
           pkg = _context.t0.parse.call(_context.t0, _context.t1);
@@ -86635,22 +86635,51 @@ var moment = /*@__PURE__*/getDefaultExportFromCjs(momentExports);
 
 /**
  * @param {string} name
+ * @param {Object} [props]
  * @returns {import('zod').ZodString}
  */
 function zId(name) {
-  return z.string().regex(/^[A-Za-z0-9\-_\[\]]+$/, {
+  var props = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  return z.string(props).regex(/^[A-Za-z0-9\-_\[\]]+$/, {
     message: "Invalid ".concat(name, " ID: ID must not contain spaces and should only contain alphanumeric characters, dashes, or underscores.")
   });
 }
 
+/**
+ * @typedef {import('zod').infer<typeof MessageSchema>} IMessage
+ */
 var MessageSchema = z.object({
-  content: z.string(),
+  id: zId('Message ID', {
+    description: 'Unique ID for the message'
+  }),
   role: z["enum"](['agent', 'customer', 'system']),
-  time: z.string(),
-  name: z.string().optional()
+  content: z.string(),
+  time: z.string({
+    description: 'Datetime ISO 8601 timestamp'
+  }),
+  name: z.string().optional(),
+  scheduled: z.string({
+    description: 'Datetime ISO 8601 timestamp'
+  }).optional(),
+  context: z.any({
+    description: 'The context generated from the message'
+  }).optional(),
+  intent: z.string({
+    description: 'Detected intent'
+  }).optional().nullable(),
+  intentScore: z.number({
+    description: 'Confidence score of the assigned intent'
+  }).nullable().optional()
 });
 
+/**
+ * @typedef {import('zod').infer<typeof customerValueSchema>} ICustomerValue
+ */
 var customerValueSchema = z.union([z["boolean"](), z.number(), z.string()]);
+
+/**
+ * @typedef {import('zod').infer<typeof customerSchema>} ICustomer
+ */
 var customerSchema = z.object({
   firstName: z.string().optional(),
   lastName: z.string().optional(),
@@ -86670,6 +86699,10 @@ var customerSchema = z.object({
   stripe: z.string().nullable().optional(),
   stripeDev: z.string().nullable().optional()
 }).catchall(customerValueSchema);
+
+/**
+ * @typedef {import('zod').infer<typeof agentBaseConfigurationSchema>} IAgentBase
+ */
 var agentBaseConfigurationSchema = z.object({
   deployed: z.object({
     web: z.string({
@@ -86682,6 +86715,7 @@ var agentBaseConfigurationSchema = z.object({
       description: 'Email address for agent'
     }).optional()
   }).optional(),
+  img: z.string().nullable().optional(),
   firstName: z.string({
     description: 'Agent first name'
   }).optional(),
@@ -86722,190 +86756,70 @@ var agentBaseConfigurationSchema = z.object({
   transcripts: z.array(z.array(MessageSchema)).optional(),
   audios: z.array(z.any()).optional()
 });
+
+/**
+ * @typedef {import('zod').infer<typeof agentBaseConfigurationSchema>} IAgent
+ * @typedef {import('zod').infer<typeof agentBaseConfigurationSchema>} IPersona
+ */
 var agentConfigurationSchema = agentBaseConfigurationSchema.extend({
-  id: zId('Agent ID', z.string({
+  id: zId('Agent ID', {
     description: 'Unique ID for agent'
-  }))
+  })
 });
+
+/**
+ * @typedef {import('zod').infer<typeof agentsConfigurationSchema>} IAgentsConfiguration
+ */
 var agentsConfigurationSchema = z.array(agentConfigurationSchema);
-var agentsBaseConfigurationSchema = z.array(agentBaseConfigurationSchema);
 
-// export type Scout9Response =
-// export type RequestHandler<
-//   RequestBody = unknown,
-//   ResponseBody = Record<string | number, any> | Record<string | number, any>[],
-//   Params extends Partial<Record<string, string>> = Partial<Record<string, string>>,
-//   RouteId extends string | null = string | null,
-//   SearchParams extends Partial<Record<string, string | string[]>> = Partial<Record<string, string>>
-// > = (event: EventRequest<RequestBody, Params, RouteId, SearchParams>) => MaybePromise<EventResponse<ResponseBody>>;
-//
-// /**
-//  * For QUERY entity api calls, this is used for getting multiple entities
-//  */
-// export type QueryRequestHandler<
-//   ResponseBody = Record<string | number, any>,
-//   Params extends Partial<Record<string, string>> = Partial<Record<string, string>>,
-//   RouteId extends string | null = string | null,
-// > = RequestHandler<unknown, ResponseBody[], Params, RouteId, {q?: string, page?: string, limit?: string, orderBy?: string, endAt?: string, startAt?: string}>;
-//
-// /**
-//  * For GET entity api calls, this is used for getting one entity
-//  */
-// export type GetRequestHandler<
-//   ResponseBody = Record<string | number, any>,
-//   Params extends Partial<Record<string, string>> = Partial<Record<string, string>>,
-//   RouteId extends string | null = string | null,
-// > = RequestHandler<unknown, ResponseBody, Params, RouteId>;
-//
-// /**
-//  * For POST entity api calls, this is used for creating an entity
-//  */
-// export type PostRequestHandler<
-//   RequestBody = Record<string | number, any>,
-//   Params extends Partial<Record<string, string>> = Partial<Record<string, string>>,
-//   RouteId extends string | null = string | null
-// > = RequestHandler<RequestBody, {success: boolean, id: string, error?: string | object, [key: string]: any}, Params, RouteId>;
-//
-// export type CreatedRequestHandler<
-//   RequestBody = Record<string | number, any>,
-//   Params extends Partial<Record<string, string>> = Partial<Record<string, string>>,
-//   RouteId extends string | null = string | null
-// > = PostRequestHandler<RequestBody, Params, RouteId>;
-//
-//
-// /**
-//  * For PUT entity api calls, this is used for creating an entity
-//  */
-// export type PutRequestHandler<
-//   RequestBody = Record<string | number, any>,
-//   Params extends Partial<Record<string, string>> = Partial<Record<string, string>>,
-//   RouteId extends string | null = string | null
-// > = RequestHandler<Partial<RequestBody>, {success: boolean, error?: string | object, [key: string]: any}, Params, RouteId>;
-//
-//
-// /**
-//  * For PUT entity api calls, this is used for creating an entity
-//  */
-// export type PatchRequestHandler<
-//   RequestBody = Record<string | number, any>,
-//   Params extends Partial<Record<string, string>> = Partial<Record<string, string>>,
-//   RouteId extends string | null = string | null
-// > = PutRequestHandler<RequestBody, Params, RouteId>;
-//
-// /**
-//  * For PUT entity api calls, this is used for creating an entity
-//  */
-// export type UpdateRequestHandler<
-//   RequestBody = Record<string | number, any>,
-//   Params extends Partial<Record<string, string>> = Partial<Record<string, string>>,
-//   RouteId extends string | null = string | null
-// > = PutRequestHandler<RequestBody, Params, RouteId>;
-//
-// /**
-//  * For PUT entity api calls, this is used for creating an entity
-//  */
-// export type DeleteRequestHandler<
-//   Params extends Partial<Record<string, string>> = Partial<Record<string, string>>,
-//   RouteId extends string | null = string | null
-// > = RequestHandler<unknown, {success: boolean, error?: string | object, [key: string]: any}, Params, RouteId>;
-//
-//
-// export interface EventRequest<
-//   Body = unknown,
-//   Params extends Partial<Record<string, string>> = Partial<Record<string, string>>,
-//   RouteId extends string | null = string | null,
-//   SearchParams extends Partial<Record<string, string | string[]>> = Partial<Record<string, string>>,
-// > {
-//
-//   /**
-//    * `fetch` is equivalent to the [native `fetch` web API](https://developer.mozilla.org/en-US/docs/Web/API/fetch), with a few additional features:
-//    *
-//    * - It can be used to make credentialed requests on the server, as it inherits the `cookie` and `authorization` headers for the page request.
-//    * - It can make relative requests on the server (ordinarily, `fetch` requires a URL with an origin when used in a server context).
-//    * - Internal requests (e.g. for `+server.js` routes) go directly to the handler function when running on the server, without the overhead of an HTTP call.
-//    * - During server-side rendering, the response will be captured and inlined into the rendered HTML by hooking into the `text` and `json` methods of the `Response` object. Note that headers will _not_ be serialized, unless explicitly included
-//    * - During hydration, the response will be read from the HTML, guaranteeing consistency and preventing an additional network request.
-//    *
-//    */
-//   fetch: typeof fetch;
-//
-//   /**
-//    * The parameters of the current route - e.g. for a route like `/blog/[slug]`, a `{ slug: string }` object
-//    */
-//   params: Params;
-//
-//   /**
-//    * The requested URL.
-//    */
-//   url: URL;
-//
-//   /**
-//    * The anticipated searchParams inside `const { searchParams } = new URL(req.url)`
-//    */
-//   searchParams: SearchParams;
-//
-//   /**
-//    * The anticipated parsed body inside `request.body`
-//    */
-//   body: Body;
-//
-//   /**
-//    * The original request object
-//    */
-//   request: Request;
-//
-//   /**
-//    * If you need to set headers for the response, you can do so using the this method. This is useful if you want the page to be cached, for example:
-//    *
-//    *	```js
-//    *	/// file: src/routes/blog/+page.js
-//    *	export async function load({ fetch, setHeaders }) {
-//    *		const url = `https://cms.example.com/articles.json`;
-//    *		const response = await fetch(url);
-//    *
-//    *		setHeaders({
-//    *			age: response.headers.get('age'),
-//    *			'cache-control': response.headers.get('cache-control')
-//    *		});
-//    *
-//    *		return response.json();
-//    *	}
-//    *	```
-//    *
-//    * Setting the same header multiple times (even in separate `load` functions) is an error — you can only set a given header once.
-//    *
-//    * You cannot add a `set-cookie` header with `setHeaders` API instead.
-//    */
-//   setHeaders(headers: Record<string, string>): void;
-//
-//   /**
-//    * Info about the current route
-//    */
-//   route: {
-//     /**
-//      * The ID of the current route - e.g. for `src/routes/blog/[slug]`, it would be `/blog/[slug]`
-//      */
-//     id: RouteId;
-//   };
-// }
+/**
+ * @typedef {import('zod').infer<typeof agentsBaseConfigurationSchema>} IAgentsBaseConfiguration
+ */
+var agentsBaseConfigurationSchema = z.array(agentBaseConfigurationSchema);
 
 /**
  * Utility runtime class used to guide event output
+ * @template T
  */
 var EventResponse = /*#__PURE__*/function () {
+  /**
+   * Create an EventResponse.
+   * @param {T} body - The body of the response.
+   * @param {ResponseInit} [init] - Additional options for the response.
+   * @throws {Error} If the body is not a valid object.
+   */
   function EventResponse(body, init) {
     spirits._classCallCheck(this, EventResponse);
+    /**
+     * @type {T}
+     * @private
+     */
     this.body = body;
+
+    /**
+     * @type {ResponseInit}
+     * @private
+     */
     this.init = init;
     if (spirits._typeof(this.body) !== 'object') {
       throw new Error("EventResponse body in not a valid object:\n\"".concat(JSON.stringify(body, null, 2), "\""));
     }
   }
+
+  /**
+   * Get the response object.
+   * @returns {Response} The response object.
+   */
   spirits._createClass(EventResponse, [{
     key: "response",
     get: function get() {
       return Response.json(this.body, this.init);
     }
+
+    /**
+     * Get the data of the response.
+     * @returns {T} The body of the response.
+     */
   }, {
     key: "data",
     get: function get() {
@@ -86913,14 +86827,44 @@ var EventResponse = /*#__PURE__*/function () {
     }
   }], [{
     key: "json",
-    value: function json(body, options) {
+    value:
+    /**
+     * Create a new EventResponse instance with a JSON body.
+     * @template T
+     * @param {T} body - The body of the response.
+     * @param {ResponseInit} [options] - Additional options for the response.
+     * @returns {EventResponse<T>} A new EventResponse instance.
+     */
+    function json(body, options) {
       return new EventResponse(body, options);
     }
   }]);
   return EventResponse;
 }();
+var responseInitSchema = z.object({
+  status: z.number().optional(),
+  statusText: z.string().optional(),
+  headers: z.any().optional() // Headers can be complex; adjust as needed
+});
+
+/**
+ * @template T
+ * @typedef {object} IEventResponse
+ * @property {T} body - The body of the response.
+ * @property {ResponseInit} [init] - Additional options for the response.
+ * @property {Response} response - The response object.
+ * @property {T} data - The body of the response.
+ */
+var eventResponseSchema = z.object({
+  body: z.any(),
+  // Adjust as per your actual body structure
+  init: responseInitSchema.optional()
+});
 
-var _entityApiConfigurationSchema = z.object({
+/**
+ * @typedef {import('zod').infer<typeof entityApiConfigurationSchema>} IEntityApiConfiguration
+ */
+var entityApiConfigurationSchema = z.object({
   // path: z.string(),
   GET: z["boolean"]().optional(),
   UPDATE: z["boolean"]().optional(),
@@ -86928,8 +86872,7 @@ var _entityApiConfigurationSchema = z.object({
   PUT: z["boolean"]().optional(),
   PATCH: z["boolean"]().optional(),
   DELETE: z["boolean"]().optional()
-});
-var entityApiConfigurationSchema = _entityApiConfigurationSchema.nullable();
+}).nullable();
 var entityConfigurationDefinitionSchema = z.object({
   utterance: zId('Utterance', z.string({
     description: 'What entity utterance this represents, if not provided, it will default to the entity id'
@@ -86969,6 +86912,10 @@ var _entityConfigurationSchema = z.object({
   training: z.array(entityConfigurationTrainingSchema).optional(),
   tests: z.array(entityConfigurationTestSchema).optional()
 }).strict();
+
+/**
+ * @typedef {import('zod').infer<typeof entityConfigurationSchema>} IEntityConfiguration
+ */
 var entityConfigurationSchema = _entityConfigurationSchema.refine(function (data) {
   // If 'definitions' is provided, then 'training' must also be provided
   if (data.definitions !== undefined) {
@@ -86980,6 +86927,10 @@ var entityConfigurationSchema = _entityConfigurationSchema.refine(function (data
   // Custom error message
   message: "If 'definitions' is provided, then 'training' must also be provided"
 });
+
+/**
+ * @typedef {import('zod').infer<typeof entitiesRootConfigurationSchema>} IEntitiesRootConfiguration
+ */
 var entitiesRootConfigurationSchema = z.array(entityConfigurationSchema);
 var entityExtendedProjectConfigurationSchema = z.object({
   entities: z.array(zId('Entity Folder', z.string()), {
@@ -86991,7 +86942,10 @@ var entityExtendedProjectConfigurationSchema = z.object({
 var _entityRootProjectConfigurationSchema = _entityConfigurationSchema.extend(entityExtendedProjectConfigurationSchema.shape);
 z.array(_entityRootProjectConfigurationSchema);
 
-// @TODO why type extend not valid?
+/**
+ * @TODO why type extend not valid?
+ * @typedef {import('zod').infer<typeof entityRootProjectConfigurationSchema>} IEntityRootProjectConfiguration
+ */
 var entityRootProjectConfigurationSchema = _entityConfigurationSchema.extend(entityExtendedProjectConfigurationSchema.shape).refine(function (data) {
   // If 'definitions' is provided, then 'training' must also be provided
   if (data.definitions !== undefined) {
@@ -87003,15 +86957,30 @@ var entityRootProjectConfigurationSchema = _entityConfigurationSchema.extend(ent
   // Custom error message
   message: "If 'definitions' is provided, then 'training' must also be provided"
 });
+
+/**
+ * @typedef {import('zod').infer<typeof entitiesRootProjectConfigurationSchema>} IEntitiesRootProjectConfiguration
+ */
 var entitiesRootProjectConfigurationSchema = z.array(entityRootProjectConfigurationSchema);
 
+/**
+ * @typedef {import('zod').infer<typeof WorkflowConfigurationSchema>} IWorkflowConfiguration
+ */
 var WorkflowConfigurationSchema = z.object({
   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())
 });
+
+/**
+ * @typedef {import('zod').infer<typeof WorkflowsConfigurationSchema>} IWorkflowsConfiguration
+ */
 var WorkflowsConfigurationSchema = z.array(WorkflowConfigurationSchema);
+
+/**
+ * @typedef {import('zod').infer<typeof ConversationSchema>} IConversation
+ */
 var ConversationSchema = z.object({
   $agent: zId('Conversation Agent ID', z.string({
     description: 'Default agent assigned to the conversation(s)'
@@ -87030,19 +86999,56 @@ var ConversationSchema = z.object({
     platformEmailThreadId: z.string({
       description: 'Used to sync email messages with the conversation'
     }).optional()
-  }).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(),
+  lockAttempts: z.number({
+    description: 'Number attempts made until conversation is locked'
+  }).optional().nullable(),
+  forwardedTo: z.string({
+    description: 'What personaId/phone/email was forwarded'
+  }).optional().nullable(),
+  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()
 });
+
+/**
+ * @typedef {import('zod').infer<typeof IntentWorkflowEventSchema>} IIntentWorkflowEvent
+ */
 var IntentWorkflowEventSchema = z.object({
   current: z.string().nullable(),
   flow: z.array(z.string()),
   initial: z.string().nullable()
 });
+
+/**
+ * @typedef {import('zod').infer<typeof WorkflowEventSchema>} IWorkflowEvent
+ */
 var WorkflowEventSchema = z.object({
   messages: z.array(MessageSchema),
   conversation: ConversationSchema,
   context: z.any(),
   message: MessageSchema,
-  agent: agentConfigurationSchema,
+  agent: agentConfigurationSchema.omit({
+    transcripts: true,
+    audios: true,
+    includedLocations: true,
+    excludedLocations: true,
+    model: true,
+    context: true
+  }),
   customer: customerSchema,
   intent: IntentWorkflowEventSchema,
   stagnationCount: z.number(),
@@ -87053,15 +87059,33 @@ var WorkflowEventSchema = z.object({
 var Primitive = z.union([z.string(), z.number(), z["boolean"]()]);
 // Assuming ConversationContext is already defined as a Zod schema
 
-// Lazy is used to handle recursive types.
+/**
+ * Lazy is used to handle recursive types.
+ * @typedef {import('zod').infer<typeof ConversationContext>} IConversation
+ */
 var ConversationContext = z.lazy(function () {
   return z.record(Primitive.or(ConversationContext));
 });
 z.record(Primitive.or(ConversationContext));
+
+/**
+ * Forward input information of a conversation
+ * @typedef {import('zod').infer<typeof ForwardSchema>} IForward
+ */
 var ForwardSchema = z.union([z["boolean"](), z.string(), z.object({
   to: z.string().optional(),
-  mode: z["enum"](['after-reply', 'immediately']).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
+ */
 var InstructionSchema = z.object({
   id: zId('Instruction ID').describe('Unique ID for the instruction, this is used to remove the instruction later'),
   content: z.string()
@@ -87070,12 +87094,17 @@ var InstructionSchema = z.object({
 /**
  * If its a string, it will be sent as a static string.
  * If it's a object or WorkflowResponseMessageAPI - it will use
+ * @typedef {import('zod').infer<typeof WorkflowResponseMessage>} IWorkflowResponseMessage
  */
 var WorkflowResponseMessage = z.union(z.string(),
 /**
  * An api call that should be called later, must return a string or {message: string}
  */
 WorkflowResponseMessageApiRequest);
+
+/**
+ * @typedef {import('zod').infer<typeof WorkflowResponseMessageApiRequest>} IWorkflowResponseMessageApiRequest
+ */
 var WorkflowResponseMessageApiRequest = z.object({
   uri: z.string(),
   data: z.any().optional(),
@@ -87085,6 +87114,7 @@ var WorkflowResponseMessageApiRequest = z.object({
 
 /**
  * The intended response provided by the WorkflowResponseMessageApiRequest
+ * @typedef {import('zod').infer<typeof WorkflowResponseMessageApiResponse>} IWorkflowResponseMessageApiResponse
  */
 var WorkflowResponseMessageApiResponse = z.union([z.string(), z.object({
   message: z.string()
@@ -87099,8 +87129,16 @@ var WorkflowResponseMessageApiResponse = z.union([z.string(), z.object({
     text: z.string()
   })
 })]);
+
+/**
+ * The workflow response object slot
+ * @typedef {import('zod').infer<typeof WorkflowResponseSlotSchema>} IWorkflowResponseSlot
+ */
 var WorkflowResponseSlotSchema = 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(),
   removeInstructions: z.array(z.string()).optional(),
   message: z.string().optional(),
@@ -87110,8 +87148,18 @@ var WorkflowResponseSlotSchema = z.object({
   contextUpsert: ConversationContext.optional(),
   resetIntent: z["boolean"]().optional()
 });
+
+/**
+ * The workflow response to send in any given workflow
+ * @typedef {import('zod').infer<typeof WorkflowResponseSchema>} IWorkflowResponse
+ */
 var WorkflowResponseSchema = z.union([WorkflowResponseSlotSchema, z.array(WorkflowResponseSlotSchema)]);
 
+/**
+ * @typedef {import('zod').infer<typeof WorkflowFunctionSchema>} IWorkflowFunction
+ */
+var WorkflowFunctionSchema = z["function"]().args(WorkflowEventSchema).returns(z.union([z.promise(WorkflowResponseSchema), WorkflowResponseSchema]));
+
 var llmModelOptions = z.union([z.literal('gpt-4-1106-preview'), z.literal('gpt-4-vision-preview'), z.literal('gpt-4'), z.literal('gpt-4-0314'), z.literal('gpt-4-0613'), z.literal('gpt-4-32k'), z.literal('gpt-4-32k-0314'), z.literal('gpt-4-32k-0613'), z.literal('gpt-3.5-turbo'), z.literal('gpt-3.5-turbo-16k'), z.literal('gpt-3.5-turbo-0301'), z.literal('gpt-3.5-turbo-0613'), z.literal('gpt-3.5-turbo-16k-0613'), z.string() // for the (string & {}) part
 ]);
 z.union([z.literal('orin-1.0'), z.literal('orin-2.0-preview')]);
@@ -87127,21 +87175,45 @@ var bardSchema = z.object({
   engine: z.literal('bard'),
   model: z.string()
 });
+
+/**
+ * Configure personal model transformer (PMT) settings to align auto replies the agent's tone
+ */
 var pmtSchema = z.object({
   engine: z.literal('scout9'),
   // model: pmtModelOptions
   model: z.string()
+}, {
+  description: 'Configure personal model transformer (PMT) settings to align auto replies the agent\'s tone'
 });
-var Scout9ProjectBuildConfigSchema = z.object({
+
+/**
+ * Represents the configuration provided in src/index.{js | ts} in a project
+ * @typedef {import('zod').infer<typeof Scout9ProjectConfigSchema>} IScout9ProjectConfig
+ */
+var Scout9ProjectConfigSchema = z.object({
+  /**
+   * Tag to reference this application
+   * @defaut your local package.json name + version, or scout9-app-v1.0.0
+   */
   tag: z.string().optional(),
   // Defaults to scout9-app-v1.0.0
-  agents: agentsBaseConfigurationSchema,
-  entities: entitiesRootProjectConfigurationSchema,
-  workflows: WorkflowsConfigurationSchema,
   llm: z.union([llmSchema, llamaSchema, bardSchema]),
+  /**
+   * Configure personal model transformer (PMT) settings to align auto replies the agent's tone
+   */
   pmt: pmtSchema,
-  initialContext: z.array(z.string()),
-  maxLockAttempts: z.number().min(0).max(20).optional(),
+  /**
+   * Determines the max auto replies without further conversation progression (defined by new context data gathered)
+   * before the conversation is locked and requires manual intervention
+   * @default 3
+   */
+  maxLockAttempts: z.number({
+    description: 'Determines the max auto replies without further conversation progression (defined by new context data gathered), before the conversation is locked and requires manual intervention'
+  }).min(0).max(20)["default"](3).optional(),
+  initialContext: z.array(z.string(), {
+    description: 'Configure the initial contexts for every conversation'
+  }),
   organization: z.object({
     name: z.string(),
     description: z.string(),
@@ -87155,6 +87227,96 @@ var Scout9ProjectBuildConfigSchema = z.object({
   }).optional()
 });
 
+/**
+ * @typedef {import('zod').infer<typeof Scout9ProjectBuildConfigSchema>} IScout9ProjectBuildConfig
+ */
+var Scout9ProjectBuildConfigSchema = Scout9ProjectConfigSchema.extend({
+  agents: agentsBaseConfigurationSchema,
+  entities: entitiesRootProjectConfigurationSchema,
+  workflows: WorkflowsConfigurationSchema
+});
+
+/**
+ * @typedef {object} IApiFunctionParams
+ * @property {Object.<string, string|string[]>} searchParams
+ * @property {Record<string, string>} params
+ */
+var apiFunctionParamsSchema = z.object({
+  searchParams: z.record(z.union([z.string(), z.array(z.string())])),
+  params: z.record(z.string())
+});
+
+/**
+ * @typedef {IApiFunctionParams & { id: string }} IApiEntityFunctionParams
+ */
+apiFunctionParamsSchema.extend({
+  id: z.string()
+});
+
+/**
+ * @template Params
+ * @template Response
+ * @typedef {function(IApiFunctionParams): Promise<EventResponse>} IApiFunction
+ */
+var apiFunctionSchema = z["function"]().args(apiFunctionParamsSchema).returns(z.promise(eventResponseSchema));
+
+/**
+ * @template Params
+ * @template Response
+ * @typedef {IApiFunction<Params, Response>} IQueryApiFunction
+ */
+var queryApiFunctionSchema = apiFunctionSchema;
+
+/**
+ * @template Params
+ * @template Response
+ * @typedef {IApiFunction<Params, Response>} GetApiFunction
+ */
+var getApiFunctionSchema = apiFunctionSchema;
+
+/**
+ * @template Params
+ * @template RequestBody
+ * @template Response
+ * @typedef {function(IApiFunctionParams & {body: Partial<RequestBody>}): Promise<EventResponse<Response>>} IPostApiFunction
+ */
+var postApiFunctionSchema = function postApiFunctionSchema(requestBodySchema) {
+  return z["function"]().args(apiFunctionParamsSchema.extend({
+    body: requestBodySchema.partial()
+  })).returns(z.promise(eventResponseSchema));
+};
+
+/**
+ * @template Params
+ * @template RequestBody
+ * @template Response
+ * @typedef {function(IApiFunctionParams & {body: Partial<RequestBody>}): Promise<EventResponse<Response>>} IPutApiFunction
+ */
+var putApiFunctionSchema = function putApiFunctionSchema(requestBodySchema) {
+  return z["function"]().args(apiFunctionParamsSchema.extend({
+    body: requestBodySchema.partial()
+  })).returns(z.promise(eventResponseSchema));
+};
+
+/**
+ * @template Params
+ * @template RequestBody
+ * @template Response
+ * @typedef {function(IApiFunctionParams & {body: Partial<RequestBody>}): Promise<EventResponse<Response>>} IPatchApiFunction
+ */
+var patchApiFunctionSchema = function patchApiFunctionSchema(requestBodySchema) {
+  return z["function"]().args(apiFunctionParamsSchema.extend({
+    body: requestBodySchema.partial()
+  })).returns(z.promise(eventResponseSchema));
+};
+
+/**
+ * @template Params
+ * @template Response
+ * @typedef {IApiFunction<Params, Response>} IDeleteApiFunction
+ */
+var deleteApiFunctionSchema = apiFunctionSchema;
+
 function loadEntityApiConfig$1(_x, _x2) {
   return _loadEntityApiConfig$1.apply(this, arguments);
 }
@@ -88349,36 +88511,8 @@ function report(config, logger) {
   logger.primary("Run ".concat(cyan('scout9 dev'), " to test your project locally"));
 }
 
-var __filename$1 = node_url.fileURLToPath((typeof document === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : (document.currentScript && document.currentScript.src || new URL('exports-291eb22e.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('exports-85e8c05c.js', document.baseURI).href)));
 var __dirname$1 = path__default["default"].dirname(__filename$1);
-
-/**
- * @returns {Promise<string>} - the output directory
- */
-// async function runNpmRunBuild({cwd = process.cwd(), src = 'src'} = {}) {
-//   const pkg = JSON.parse(fss.readFileSync(new URL(`${cwd}/package.json`, import.meta.url), 'utf-8'));
-//   // Package.json must have a "build" script
-//   const buildScript = pkg.scripts?.build;
-//   if (!buildScript) {
-//     // If no build script then just return src
-//     return path.resolve(cwd, src);
-//   }
-//   // "build" script cannot contain "scout9 build" (otherwise we'll get stuck in a loop)
-//   if (buildScript.includes('scout9 build')) {
-//     throw new Error(`"build" script in ${cwd}/package.json cannot contain "scout9 build"`);
-//   }
-//
-//   return new Promise((resolve, reject) => {
-//     exec('npm run build', {cwd}, (error, stdout, stderr) => {
-//       if (error) {
-//         return reject(error);
-//       }
-//       // @TODO don't assume build script created a "build" directory (use a config)
-//       return resolve(path.resolve(cwd, 'build'));
-//     });
-//   });
-// }
-
 function zipDirectory(source, out) {
   var archive = archiver$1('tar', {
     gzip: true,
@@ -88592,7 +88726,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('exports-291eb22e.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('exports-85e8c05c.js', document.baseURI).href))), 'utf-8');
         case 14:
           _context4.t1 = _context4.sent;
           packageTemplate = _context4.t0.parse.call(_context4.t0, _context4.t1);
@@ -88674,6 +88808,13 @@ function _buildApp() {
 function downloadDevApp(_x8, _x9) {
   return _downloadDevApp.apply(this, arguments);
 }
+/**
+ * @param {Object} [options]
+ * @param {string} [options.cwd]
+ * @param {string} [options.src]
+ * @param {boolean} [options.ignoreAppRequire]
+ * @returns {Promise<{app: *, fileName: string, exe: string, filePath: string}>}
+ */
 function _downloadDevApp() {
   _downloadDevApp = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee5(destination, version) {
     var url, downloadLocalResponse, arrayBuffer;
@@ -88804,10 +88945,10 @@ function getAgentContacts() {
  * Runs a given project container from scout9 to given environment
  * Runs the project in a container
  *
- * @param {WorkflowEvent} event - every workflow receives an event object
+ * @param {import('../runtime/client/workflow.js').IWorkflowEvent} event - every workflow receives an event object
  * @param {Object} options
  * @param {string} options.eventSource - the source path of the event
- * @returns {Promise<WorkflowResponse<any>>}
+ * @returns {Promise<import('../runtime/client/workflow.js').IWorkflowResponse>}
  */
 function _getAgentContacts() {
   _getAgentContacts = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee7() {
@@ -88907,7 +89048,7 @@ function runConfig() {
 /**
  * Builds a local project
  * @param {{cwd: string; src: string; dest: string; logger: ProgressLogger; mode: string;}} - build options
- * @param {Scout9ProjectBuildConfig} config
+ * @param {import('../runtime/client/').IScout9ProjectBuildConfig} config
  * @returns {messages: string[]}
  */
 function _runConfig() {
@@ -88950,6 +89091,7 @@ function build() {
  * Deploys a local project to scout9
  * @param {{cwd: string; src: string, dest: string}} - build options
  * @param {Scout9ProjectBuildConfig} config
+ * @return {Promise<{deploy: Object, contacts: any}>}
  */
 function _build() {
   _build = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee10() {
@@ -89041,7 +89183,7 @@ function deploy(_x11, _x12) {
 /**
  * Tests a local project to scout9 by running a dummy parse command with the project's local entities
  * @param {{cwd: string; src: string, dest: string}} - build options
- * @param {Scout9ProjectBuildConfig} config
+ * @param {import('../runtime/client/config.js').IScout9ProjectBuildConfig} config
  */
 function _deploy() {
   _deploy = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee11(_ref4, config) {
@@ -89117,8 +89259,8 @@ function test(_x13, _x14) {
 /**
  *
  * @param {{cwd: string; src: string; projectFiles: ProjectFiles; logger: ProgressLogger}} options
- * @param {Scout9ProjectBuildConfig} config
- * @returns {Promise<{success: boolean; config: Scout9ProjectBuildConfig}>}
+ * @param {import('../runtime/client/config.js').IScout9ProjectBuildConfig} config
+ * @returns {Promise<{success: boolean; config: import('../runtime/client/config.js').IScout9ProjectBuildConfig}>}
  */
 function _test() {
   _test = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee12(_ref5, config) {
@@ -90488,7 +90630,7 @@ var Scout9Platform = {
    * @param {string} [params.cwd=process.cwd()] - the working directory
    * @param {string} [params.src='src'] - the source directory
    * @param {string} [params.mode='production'] - the build mode
-   * @returns {Promise<Scout9ProjectBuildConfig>}
+   * @returns {Promise<import('./runtime/client/config.js').IScout9ProjectBuildConfig>}
    */
   sync: function () {
     var _sync2 = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee() {
@@ -90563,7 +90705,7 @@ var Scout9Platform = {
    * @param {string} [params.dest='/tmp/project'] - the destination directory
    * @param {'development' | 'production'} [params.mode='production'] - the build mode
    * @param {boolean} [params.sync=true] - whether to sync the project after deploying
-   * @returns {Promise<Scout9ProjectBuildConfig>}
+   * @returns {Promise<import('./runtime/client/config.js').IScout9ProjectBuildConfig>}
    */
   deploy: function () {
     var _deploy2 = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee2() {
@@ -90685,7 +90827,7 @@ var Scout9Platform = {
    * @param {string} [params.src='./src'] - the source directory
    * @param {string} [params.dest='/tmp/project'] - the destination directory
    * @param {'development' | 'production'} [params.mode='production'] - the build mode
-   * @returns {Promise<Scout9ProjectBuildConfig>}
+   * @returns {Promise<import('./runtime/client/config.js').IScout9ProjectBuildConfig>}
    */
   test: function () {
     var _test2 = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee3() {
@@ -90759,7 +90901,7 @@ var Scout9Platform = {
    * @param {string} [params.src='./src'] - the source directory
    * @param {string} [params.dest='/tmp/project'] - the destination directory
    * @param {'development' | 'production'} [params.mode='production'] - the build mode
-   * @returns {Promise<Scout9ProjectBuildConfig>}
+   * @returns {Promise<import('./runtime/client/config.js').IScout9ProjectBuildConfig>}
    */
   build: function () {
     var _build2 = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee4() {
@@ -90836,7 +90978,7 @@ var Scout9Platform = {
    * @param {string} [params.cwd=process.cwd()] - the working directory
    * @param {boolean} [params.local=false] - whether to only load the local config (ignores what's saved on server)
    * @param {string} [params.src='./src'] - the source directory
-   * @returns {Promise<Scout9ProjectBuildConfig>}
+   * @returns {Promise<import('./runtime/client/config.js').IScout9ProjectBuildConfig>}
    */
   config: function () {
     var _config = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee5() {
@@ -90890,13 +91032,13 @@ var Scout9Platform = {
   }(),
   /**
    * Runs the project in a container
-   * @param {WorkflowEvent} event - every workflow receives an event object
+   * @param {import('./runtime/client/workflow.js').IWorkflowEvent} event - every workflow receives an event object
    * @param {Object} options
    * @param {string} [options.cwd=process.cwd()] - the working directory
    * @param {string} [options.mode='production'] - the build mode
    * @param {string} [options.src='./src'] - the source directory
    * @param {string} options.eventSource - the source of the workflow event
-   * @returns {Promise<WorkflowResponse<any>>}
+   * @returns {Promise<import('./runtime/client/workflow.js').IWorkflowResponse>}
    */
   run: function () {
     var _run2 = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee6(event, _ref6) {
@@ -91606,18 +91748,22 @@ var Scout9Test = /*#__PURE__*/function () {
 }();
 
 /**
- * @param {WorkflowEvent} event - every workflow receives an event object
- * @param {{cwd: string; mode: 'development' | 'production'; src: string}} options - build options
- * @returns {Promise<WorkflowResponse<any>>}
+ * @param {import('./runtime/client/workflow.js').IWorkflowEvent} event - every workflow receives an event object
+ * @param {Object} options
+ * @param {string} [options.cwd=process.cwd()] - the working directory
+ * @param {string} [options.mode='production'] - the build mode
+ * @param {string} [options.src='./src'] - the source directory
+ * @param {string} options.eventSource - the source of the workflow event
+ * @returns {Promise<import('./runtime/client/workflow.js').IWorkflowResponse>}
  */
 function run(_x, _x2) {
   return _run.apply(this, arguments);
 }
 
 /**
- * @param {WorkflowEvent} event - every workflow receives an event object
+ * @param {import('./runtime/client/workflow.js').IWorkflowEvent} event - every workflow receives an event object
  * @param {{cwd: string; mode: 'development' | 'production'; src: string}} options - build options
- * @returns {Promise<WorkflowResponse<any>>}
+ * @returns {Promise<import('./runtime/client/workflow.js').IWorkflowResponse>}
  */
 function _run() {
   _run = spirits._asyncToGenerator( /*#__PURE__*/spirits._regeneratorRuntime().mark(function _callee(event, options) {
@@ -91638,7 +91784,7 @@ var sendEvent = run;
 /**
  * @param data {T}
  * @param init {ResponseInit | undefined}
- * @returns {EventResponse<T>}
+ * @returns {import('./runtime/client/api.js').EventResponse<T>}
  */
 function json(data, init) {
   if (data instanceof Promise) {
@@ -91674,20 +91820,22 @@ exports.InstructionSchema = InstructionSchema;
 exports.IntentWorkflowEventSchema = IntentWorkflowEventSchema;
 exports.MessageSchema = MessageSchema;
 exports.Scout9ProjectBuildConfigSchema = Scout9ProjectBuildConfigSchema;
+exports.Scout9ProjectConfigSchema = Scout9ProjectConfigSchema;
 exports.Scout9Test = Scout9Test;
 exports.WorkflowConfigurationSchema = WorkflowConfigurationSchema;
 exports.WorkflowEventSchema = WorkflowEventSchema;
+exports.WorkflowFunctionSchema = WorkflowFunctionSchema;
 exports.WorkflowResponseMessage = WorkflowResponseMessage;
 exports.WorkflowResponseMessageApiRequest = WorkflowResponseMessageApiRequest;
 exports.WorkflowResponseMessageApiResponse = WorkflowResponseMessageApiResponse;
 exports.WorkflowResponseSchema = WorkflowResponseSchema;
 exports.WorkflowResponseSlotSchema = WorkflowResponseSlotSchema;
 exports.WorkflowsConfigurationSchema = WorkflowsConfigurationSchema;
-exports._entityApiConfigurationSchema = _entityApiConfigurationSchema;
 exports.agentBaseConfigurationSchema = agentBaseConfigurationSchema;
 exports.agentConfigurationSchema = agentConfigurationSchema;
 exports.agentsBaseConfigurationSchema = agentsBaseConfigurationSchema;
 exports.agentsConfigurationSchema = agentsConfigurationSchema;
+exports.apiFunctionSchema = apiFunctionSchema;
 exports.createMockAgent = createMockAgent;
 exports.createMockConversation = createMockConversation;
 exports.createMockCustomer = createMockCustomer;
@@ -91695,11 +91843,18 @@ exports.createMockMessage = createMockMessage;
 exports.createMockWorkflowEvent = createMockWorkflowEvent;
 exports.customerSchema = customerSchema;
 exports.customerValueSchema = customerValueSchema;
+exports.deleteApiFunctionSchema = deleteApiFunctionSchema;
 exports.entitiesRootConfigurationSchema = entitiesRootConfigurationSchema;
 exports.entitiesRootProjectConfigurationSchema = entitiesRootProjectConfigurationSchema;
 exports.entityApiConfigurationSchema = entityApiConfigurationSchema;
 exports.entityConfigurationSchema = entityConfigurationSchema;
 exports.entityRootProjectConfigurationSchema = entityRootProjectConfigurationSchema;
+exports.eventResponseSchema = eventResponseSchema;
+exports.getApiFunctionSchema = getApiFunctionSchema;
 exports.json = json;
+exports.patchApiFunctionSchema = patchApiFunctionSchema;
+exports.postApiFunctionSchema = postApiFunctionSchema;
+exports.putApiFunctionSchema = putApiFunctionSchema;
+exports.queryApiFunctionSchema = queryApiFunctionSchema;
 exports.run = run;
 exports.sendEvent = sendEvent;