@scout9/app 1.0.0-alpha.0.1.95 → 1.0.0-alpha.0.1.97

package/dist/{spirits-32395ac4.cjs → spirits-43ce19cf.cjs}

@@ -587,35 +587,35 @@ function _classCheckPrivateStaticFieldDescriptor(descriptor, action) {
 
 /**
  * @typedef {Object} ConversationData
- * @property {import('../runtime/client/config.js').IScout9ProjectBuildConfig} config - used to define generation and extract persona metadata
- * @property {import('../runtime/client/workflow.js').IConversation} conversation
- * @property {Array<import('../runtime/client/message.js').IMessage>} messages
- * @property {import('../runtime/client/message.js').IMessage} message - the message sent by the customer (should exist in messages)
- * @property {import('../runtime/client/users.js').ICustomer} customer
+ * @property {import('@scout9/app').Scout9ProjectBuildConfig} config - used to define generation and extract persona metadata
+ * @property {import('@scout9/app').Conversation} conversation
+ * @property {Array<import('@scout9/app').Message>} messages
+ * @property {import('@scout9/app').Message} message - the message sent by the customer (should exist in messages)
+ * @property {import('@scout9/app').Customer} customer
  * @property {any} context
  */
 
 /**
  * @typedef {Object} ParseOutput
- * @property {Array<import('../runtime/client/message.js').IMessage>} messages
- * @property {import('../runtime/client/workflow.js').IConversation} conversation
- * @property {import('../runtime/client/message.js').IMessage} message
+ * @property {Array<import('@scout9/app').Message>} messages
+ * @property {import('@scout9/app').Conversation} conversation
+ * @property {import('@scout9/app').Message} message
  * @property {any} context
  */
 
 /**
  * @typedef {Object} WorkflowOutput
- * @property {Array<import('../runtime/client/workflow.js').IWorkflowResponseSlot>} slots
- * @property {Array<import('../runtime/client/message.js').IMessage>} messages
- * @property {import('../runtime/client/workflow.js').IConversation} conversation
+ * @property {Array<import('@scout9/app').WorkflowResponseSlot>} slots
+ * @property {Array<import('@scout9/app').Message>} messages
+ * @property {import('@scout9/app').Conversation} conversation
  * @property {any} context
  */
 
 /**
  * @typedef {Object} GenerateOutput
  * @property {import('@scout9/admin').GenerateResponse | undefined} generate
- * @property {Array<import('../runtime/client/message.js').IMessage>} messages
- * @property {import('../runtime/client/workflow.js').IConversation} conversation
+ * @property {Array<import('@scout9/app').Message>} messages
+ * @property {import('@scout9/app').Conversation} conversation
  * @property {any} context
  */
 
@@ -628,8 +628,8 @@ function _classCheckPrivateStaticFieldDescriptor(descriptor, action) {
 
 /**
  * @callback WorkflowFun
- * @param {import('../runtime/client/workflow.js').IWorkflowEvent} event - conversation data
- * @returns {Promise<import('../runtime/client/workflow.js').IWorkflowResponse>}
+ * @param {import('@scout9/app').WorkflowEvent} event - conversation data
+ * @returns {Promise<import('@scout9/app').WorkflowResponse>}
  */
 
 /**
@@ -640,7 +640,7 @@ function _classCheckPrivateStaticFieldDescriptor(descriptor, action) {
 
 /**
  * @callback IdGeneratorFun
- * @param {import('../runtime/client/message.js').IMessage.role} prefix
+ * @param {import('@scout9/app').Message['role']} prefix
  * @returns {string}
  */
 /**
@@ -663,10 +663,10 @@ function _classCheckPrivateStaticFieldDescriptor(descriptor, action) {
 
 /**
  * @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<import('@scout9/app').Conversation> & {forwardNote?: string; forward?: import('@scout9/app').WorkflowResponseSlot['forward']}} conversation
+ * @property {Change<Array<import('@scout9/app').Message>>} messages
  * @property {Change<any>} context
- * @property {Change<import('../runtime/client/message.js').IMessage>} message
+ * @property {Change<import('@scout9/app').Message>} message
  */
 var Spirits = {
   /**

package/dist/spirits.cjs

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var spirits = require("./spirits-32395ac4.cjs");
+var spirits = require("./spirits-43ce19cf.cjs");
 
 
 

package/dist/testing-tools.cjs

@@ -2,8 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var dev = require("./dev-ecdbe765.cjs");
-var spirits = require("./spirits-32395ac4.cjs");
+var dev = require("./dev-1afc1e7b.cjs");
+require("./spirits-43ce19cf.cjs");
 require('util');
 require('stream');
 require('path');
@@ -20,12 +20,14 @@ require('crypto');
 require('node:fs');
 require('node:path');
 require('node:fs/promises');
-require('fs/promises');
-require('string_decoder');
+require('node:url');
+require('node:events');
+require('node:stream');
+require('node:string_decoder');
 require('node:readline');
 require('node:process');
-require('node:url');
 require('node:os');
+require('fs/promises');
 
 
 
@@ -35,4 +37,3 @@ exports.createMockConversation = dev.createMockConversation;
 exports.createMockCustomer = dev.createMockCustomer;
 exports.createMockMessage = dev.createMockMessage;
 exports.createMockWorkflowEvent = dev.createMockWorkflowEvent;
-exports.Spirits = spirits.Spirits;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scout9/app",
-  "version": "1.0.0-alpha.0.1.95",
+  "version": "1.0.0-alpha.0.1.97",
   "description": "Build and deploy your Scout9 app for SMS auto replies",
   "publishConfig": {
     "access": "public"
@@ -73,10 +73,12 @@
     "babel-jest": "^29.7.0",
     "babel-preset-minify": "^0.5.2",
     "dts-buddy": "^0.4.3",
+    "glob": "^11.0.0",
     "jest": "^29.7.0",
     "rollup": "^2.79.1",
     "rollup-plugin-babel": "^4.4.0",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "zod-to-ts": "^1.2.0"
   },
   "dependencies": {
     "@scout9/admin": "^1.0.0-alpha.0.0.39",
@@ -87,7 +89,6 @@
     "decompress": "^4.2.1",
     "dotenv": "^16.3.1",
     "fast-xml-parser": "^4.3.5",
-    "glob": "^10.3.10",
     "graphql-request": "^6.1.0",
     "kleur": "^4.1.5",
     "log-update": "^6.0.0",

package/src/core/config/agents.js

@@ -4,7 +4,7 @@ import colors from 'kleur';
 import { globSync } from 'glob';
 import { Configuration, Scout9Api } from '@scout9/admin';
 import { checkVariableType, requireProjectFile } from '../../utils/index.js';
-import { agentsBaseConfigurationSchema, agentsConfigurationSchema } from '../../runtime/index.js';
+import { AgentsSchema, AgentsConfigurationSchema } from '../../runtime/index.js';
 import { audioExtensions } from '../../utils/audio-type.js';
 import { fileTypeFromBuffer } from '../../utils/file-type.js';
 import { videoExtensions } from '../../utils/video-type.js';
@@ -313,7 +313,7 @@ export default async function loadAgentConfig({
     }
   }
 
-  const result = (deploying ? agentsConfigurationSchema : agentsBaseConfigurationSchema).safeParse(agents);
+  const result = (deploying ? AgentsConfigurationSchema : AgentsSchema).safeParse(agents);
   if (!result.success) {
     result.error.source = paths[0];
     throw result.error;

package/src/core/config/entities.js

@@ -1,10 +1,10 @@
 import { globSync } from 'glob';
 import path from 'node:path';
 import {
-    entitiesRootProjectConfigurationSchema,
-    entityApiConfigurationSchema,
-    entityConfigurationSchema,
-    entityRootProjectConfigurationSchema
+    EntitiesRootProjectConfigurationSchema,
+    EntityApiConfigurationSchema,
+    EntityConfigurationSchema,
+    EntityRootProjectConfigurationSchema
 } from '../../runtime/index.js';
 import { checkVariableType, requireOptionalProjectFile, requireProjectFile } from '../../utils/index.js';
 import { logUserValidationError } from '../../report.js';
@@ -23,7 +23,7 @@ async function loadEntityApiConfig(cwd, filePath) {
         config[key] = true;
       }
     }
-    entityApiConfigurationSchema.parse(config);
+    EntityApiConfigurationSchema.parse(config);
     return config;
   } else {
     return null;
@@ -31,12 +31,12 @@ async function loadEntityApiConfig(cwd, filePath) {
 }
 
 /**
- * @returns {Promise<import('../../runtime/client/config.js').IEntitiesRootProjectConfiguration>}
+ * @returns {Promise<EntitiesRootProjectConfiguration>}
  */
 export default async function loadEntitiesConfig(
   {cwd = process.cwd(), src = 'src', logger, cb = (message) => {}} = {}
 ) {
-  /** @type import('../../runtime/client/config.js').IEntitiesRootProjectConfiguration */
+  /** @type EntitiesRootProjectConfiguration */
   const config = [];
   // const paths = globSync(path.resolve(cwd, `${src}/entities/**/{index,config,api}.{ts,js}`), {cwd, absolute: true});
   const filePaths = globSync(`${src}/entities/**/{index,config,api}.{ts,js}`, {cwd, absolute: true});
@@ -79,7 +79,7 @@ export default async function loadEntitiesConfig(
       }
 
       // Validate entity configuration
-      const result = entityConfigurationSchema.safeParse(entityConfig, {path: ['entities', config.length]});
+      const result = EntityConfigurationSchema.safeParse(entityConfig, {path: ['entities', config.length]});
       if (!result.success) {
         logUserValidationError(result.error, filePath);
         throw result.error;
@@ -96,7 +96,7 @@ export default async function loadEntitiesConfig(
       entities: parents.reverse(),
       api
     };
-    entityRootProjectConfigurationSchema.parse(entityProjectConfig);
+    EntityRootProjectConfigurationSchema.parse(entityProjectConfig);
     const existingIndex = config.findIndex(c => c.entity === entityProjectConfig.entity);
     if (existingIndex > -1) {
       if (config[existingIndex].entities.length !== entityProjectConfig.entities.length) {
@@ -134,7 +134,7 @@ export default async function loadEntitiesConfig(
   }
 
   // Validate the config
-  entitiesRootProjectConfigurationSchema.parse(config);
+  EntitiesRootProjectConfigurationSchema.parse(config);
 
   return config;
 }

package/src/core/config/index.js

@@ -34,7 +34,7 @@ export function loadEnvConfig({
 /**
  * @deprecated use "new ProjectFiles(...).load()" instead
  * @param {{cwd: string; src: string; logger?: ProgressLogger; deploying?: boolean; cb?: (message: string) => void}} - build options
- * @returns {Promise<import('../../runtime/client/config.js').IScout9ProjectBuildConfig>}
+ * @returns {Promise<Scout9ProjectBuildConfig>}
  */
 export async function loadConfig({
   cwd = process.cwd(), src = 'src', dest = '/tmp/project', deploying = false, logger = new ProgressLogger(), cb = (msg) => {
@@ -49,7 +49,7 @@ export async function loadConfig({
   const workflowsConfig = await loadWorkflowsConfig({cwd, src, logger, deploying, cb});
 
   /**
-   * @type {import('../../runtime/client/config.js').IScout9ProjectBuildConfig}
+   * @type {Scout9ProjectBuildConfig}
    */
   const projectConfig = {
     ...baseProjectConfig,

package/src/core/config/project.js

@@ -55,7 +55,7 @@ export async function loadUserPackageJson({cwd = process.cwd()}) {
 }
 
 /**
- * @returns {Promise<import('../../runtime/client/config.js').IScout9ProjectConfig>}
+ * @returns {Promise<Scout9ProjectConfig>}
  */
 export default async function loadProjectConfig({cwd = process.cwd(), deploying = false, src = 'src', cb = (message) => {}} = {}) {
   // Grab the project tag name (from their package.json)

package/src/core/config/workflow.js

@@ -3,7 +3,7 @@ import { WorkflowConfigurationSchema, WorkflowsConfigurationSchema } from '../..
 
 
 /**
- * @returns {Promise<import('../../runtime/client/workflow.js').IWorkflowsConfiguration>}
+ * @returns {Promise<WorkflowsConfiguration>}
  */
 export default async function loadWorkflowsConfig(
   {
@@ -30,7 +30,7 @@ export default async function loadWorkflowsConfig(
     .map(({path, parents}) => {
 
       // Validate project configuration
-      /** @type {import('../../runtime/client/workflow.js').IWorkflowConfiguration} */
+      /** @type {WorkflowConfiguration} */
       const workflowConfig = {
         entity: parents[0],
         entities: parents.reverse(),

package/src/core/index.js

@@ -98,7 +98,7 @@ async function downloadAndUnpackZip(outputDir) {
  * @param {string} cwd
  * @param {string} src
  * @param {string} dest
- * @param {import('../runtime/client/config.js').IScout9ProjectBuildConfig} config
+ * @param {Scout9ProjectBuildConfig} config
  * @returns {Promise<void>}
  */
 async function buildApp(cwd, src, dest, config) {
@@ -292,10 +292,10 @@ export async function getAgentContacts() {
  * Runs a given project container from scout9 to given environment
  * Runs the project in a container
  *
- * @param {import('../runtime/client/workflow.js').IWorkflowEvent} event - every workflow receives an event object
+ * @param {WorkflowEvent} event - every workflow receives an event object
  * @param {Object} options
  * @param {string} options.eventSource - the source path of the event
- * @returns {Promise<import('../runtime/client/workflow.js').IWorkflowResponse>}
+ * @returns {Promise<WorkflowResponse>}
  */
 export async function run(event, {eventSource} = {}) {
   const result = WorkflowEventSchema.safeParse(event);
@@ -338,7 +338,7 @@ export async function runConfig() {
 /**
  * Builds a local project
  * @param {{cwd: string; src: string; dest: string; logger: ProgressLogger; mode: string;}} - build options
- * @param {import('../runtime/client/').IScout9ProjectBuildConfig} config
+ * @param {Scout9ProjectBuildConfig} config
  * @returns {messages: string[]}
  */
 export async function build({
@@ -435,7 +435,7 @@ export async function deploy(
 /**
  * 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 {import('../runtime/client/config.js').IScout9ProjectBuildConfig} config
+ * @param {Scout9ProjectBuildConfig} config
  */
 export async function test(
   {cwd = process.cwd(), src = './src', dest = '/tmp/project', logger = new ProgressLogger()},
@@ -467,8 +467,8 @@ export async function test(
 /**
  *
  * @param {{cwd: string; src: string; projectFiles: ProjectFiles; logger: ProgressLogger}} options
- * @param {import('../runtime/client/config.js').IScout9ProjectBuildConfig} config
- * @returns {Promise<{success: boolean; config: import('../runtime/client/config.js').IScout9ProjectBuildConfig}>}
+ * @param {Scout9ProjectBuildConfig} config
+ * @returns {Promise<{success: boolean; config: Scout9ProjectBuildConfig}>}
  */
 export async function sync({
   cwd = process.cwd(), src = 'src',

package/src/core/sync.js

@@ -1,8 +1,8 @@
 import { platformApi } from './data.js';
 
 /**
- * @param {import('../runtime/client/config.js').IScout9ProjectBuildConfig} config
- * @returns {Promise<import('../runtime/client/config.js').IScout9ProjectBuildConfig>}
+ * @param {Scout9ProjectBuildConfig} config
+ * @returns {Promise<Scout9ProjectBuildConfig>}
  */
 export async function syncData(config) {
   if (!process.env.SCOUT9_API_KEY) {

package/src/core/templates/app.js

@@ -5,7 +5,7 @@ import bodyParser from 'body-parser';
 import colors from 'kleur';
 import { config as dotenv } from 'dotenv';
 import { Configuration, Scout9Api } from '@scout9/admin';
-import { EventResponse } from '@scout9/app';
+import { EventResponse, WorkflowEventSchema } from '@scout9/app';
 import path from 'node:path';
 import fs from 'node:fs';
 import https from 'node:https';
@@ -162,8 +162,12 @@ if (dev) {
 // Root application POST endpoint will run the scout9 app
 app.post(dev ? '/dev/workflow' : '/', async (req, res) => {
   try {
-    // @TODO use zod to check if req.body is a valid event object
-    const response = await projectApp(req.body);
+    const event = WorkflowEventSchema.parse(req.body.event);
+    globalThis.SCOUT9 = {
+      ...event,
+      $convo: req.body.$convo,
+    }
+    const response = await projectApp(event);
     res.writeHead(200, {'Content-Type': 'application/json'});
     res.end(JSON.stringify(response));
   } catch (e) {

package/src/core/templates/project-files.js

@@ -15,7 +15,7 @@ const resolveFilePath = () => {
 export const entities = {
   /**
    * Generates ./src/entities/
-   * @param {import('../../runtime/client/config.js').IScout9ProjectBuildConfig} config
+   * @param {Scout9ProjectBuildConfig} config
    * @param {string} cwd
    * @param {string} src
    * @returns {Promise<void>}

package/src/exports.js

@@ -8,29 +8,30 @@ 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
+ * @param {WorkflowEvent} 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>}
+ * @returns {WorkflowResponse}
  */
 export async function run(event, options) {
   return Scout9Platform.run(event, options)
 }
 
 /**
- * @param {import('./runtime/client/workflow.js').IWorkflowEvent} event - every workflow receives an event object
+ * @param {WorkflowEvent} event - every workflow receives an event object
  * @param {{cwd: string; mode: 'development' | 'production'; src: string}} options - build options
- * @returns {Promise<import('./runtime/client/workflow.js').IWorkflowResponse>}
+ * @returns {WorkflowResponse}
  */
 export const sendEvent = run;
 
 /**
- * @param data {T}
- * @param init {ResponseInit | undefined}
- * @returns {import('./runtime/client/api.js').EventResponse<T>}
+ * @template T
+ * @param {T} data
+ * @param {ResponseInit | undefined} [init]
+ * @returns {EventResponse<T>}
  */
 export function json(data, init) {
   if (data instanceof Promise) {

package/src/platform.js

@@ -23,7 +23,7 @@ export const 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<import('./runtime/client/config.js').IScout9ProjectBuildConfig>}
+   * @returns {Promise<Scout9ProjectBuildConfig>}
    */
   sync: async function ({cwd = process.cwd(), src = 'src', mode = 'production'} = {}) {
     const logger = new ProgressLogger();
@@ -54,7 +54,7 @@ export const 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<import('./runtime/client/config.js').IScout9ProjectBuildConfig>}
+   * @returns {Promise<Scout9ProjectBuildConfig>}
    */
   deploy: async function (
     {
@@ -108,7 +108,7 @@ export const 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<import('./runtime/client/config.js').IScout9ProjectBuildConfig>}
+   * @returns {Promise<Scout9ProjectBuildConfig>}
    */
   test: async function ({cwd = process.cwd(), src = './src', dest = '/tmp/project', mode = 'production'} = {}) {
     const logger = new ProgressLogger();
@@ -136,7 +136,7 @@ export const 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<import('./runtime/client/config.js').IScout9ProjectBuildConfig>}
+   * @returns {Promise<Scout9ProjectBuildConfig>}
    */
   build: async function ({cwd = process.cwd(), src = './src', dest = '/tmp/project', mode = 'production'} = {}) {
     const logger = new ProgressLogger();
@@ -168,7 +168,7 @@ export const 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<import('./runtime/client/config.js').IScout9ProjectBuildConfig>}
+   * @returns {Promise<Scout9ProjectBuildConfig>}
    */
   config: async function ({cwd = process.cwd(), local = false, src = './src'} = {}) {
     try {
@@ -188,13 +188,13 @@ export const Scout9Platform = {
 
   /**
    * Runs the project in a container
-   * @param {import('./runtime/client/workflow.js').IWorkflowEvent} event - every workflow receives an event object
+   * @param {WorkflowEvent} 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>}
+   * @returns {WorkflowResponse}
    */
   run: async function (
     event,