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

package/dist/index.cjs

@@ -2,8 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var exports$1 = require("./exports-291eb22e.cjs");
-var spirits = require("./spirits-643c422a.cjs");
+var exports$1 = require("./exports-b2e88386.cjs");
+var spirits = require("./spirits-1dc18cf4.cjs");
 require('node:readline');
 require('fs');
 require('events');
@@ -47,20 +47,22 @@ exports.InstructionSchema = exports$1.InstructionSchema;
 exports.IntentWorkflowEventSchema = exports$1.IntentWorkflowEventSchema;
 exports.MessageSchema = exports$1.MessageSchema;
 exports.Scout9ProjectBuildConfigSchema = exports$1.Scout9ProjectBuildConfigSchema;
+exports.Scout9ProjectConfigSchema = exports$1.Scout9ProjectConfigSchema;
 exports.Scout9Test = exports$1.Scout9Test;
 exports.WorkflowConfigurationSchema = exports$1.WorkflowConfigurationSchema;
 exports.WorkflowEventSchema = exports$1.WorkflowEventSchema;
+exports.WorkflowFunctionSchema = exports$1.WorkflowFunctionSchema;
 exports.WorkflowResponseMessage = exports$1.WorkflowResponseMessage;
 exports.WorkflowResponseMessageApiRequest = exports$1.WorkflowResponseMessageApiRequest;
 exports.WorkflowResponseMessageApiResponse = exports$1.WorkflowResponseMessageApiResponse;
 exports.WorkflowResponseSchema = exports$1.WorkflowResponseSchema;
 exports.WorkflowResponseSlotSchema = exports$1.WorkflowResponseSlotSchema;
 exports.WorkflowsConfigurationSchema = exports$1.WorkflowsConfigurationSchema;
-exports._entityApiConfigurationSchema = exports$1._entityApiConfigurationSchema;
 exports.agentBaseConfigurationSchema = exports$1.agentBaseConfigurationSchema;
 exports.agentConfigurationSchema = exports$1.agentConfigurationSchema;
 exports.agentsBaseConfigurationSchema = exports$1.agentsBaseConfigurationSchema;
 exports.agentsConfigurationSchema = exports$1.agentsConfigurationSchema;
+exports.apiFunctionSchema = exports$1.apiFunctionSchema;
 exports.createMockAgent = exports$1.createMockAgent;
 exports.createMockConversation = exports$1.createMockConversation;
 exports.createMockCustomer = exports$1.createMockCustomer;
@@ -68,12 +70,19 @@ exports.createMockMessage = exports$1.createMockMessage;
 exports.createMockWorkflowEvent = exports$1.createMockWorkflowEvent;
 exports.customerSchema = exports$1.customerSchema;
 exports.customerValueSchema = exports$1.customerValueSchema;
+exports.deleteApiFunctionSchema = exports$1.deleteApiFunctionSchema;
 exports.entitiesRootConfigurationSchema = exports$1.entitiesRootConfigurationSchema;
 exports.entitiesRootProjectConfigurationSchema = exports$1.entitiesRootProjectConfigurationSchema;
 exports.entityApiConfigurationSchema = exports$1.entityApiConfigurationSchema;
 exports.entityConfigurationSchema = exports$1.entityConfigurationSchema;
 exports.entityRootProjectConfigurationSchema = exports$1.entityRootProjectConfigurationSchema;
+exports.eventResponseSchema = exports$1.eventResponseSchema;
+exports.getApiFunctionSchema = exports$1.getApiFunctionSchema;
 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.run = exports$1.run;
 exports.sendEvent = exports$1.sendEvent;
 exports.Spirits = spirits.Spirits;

package/dist/{multipart-parser-caa634a9.cjs → multipart-parser-78fb466c.cjs}

@@ -2,8 +2,8 @@
 
 require('node:fs');
 require('node:path');
-var exports$1 = require("./exports-291eb22e.cjs");
-require("./spirits-643c422a.cjs");
+var exports$1 = require("./exports-b2e88386.cjs");
+require("./spirits-1dc18cf4.cjs");
 require('node:readline');
 require('fs');
 require('events');

package/dist/{spirits-643c422a.cjs → spirits-1dc18cf4.cjs}

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

package/dist/spirits.cjs

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var spirits = require("./spirits-643c422a.cjs");
+var spirits = require("./spirits-1dc18cf4.cjs");
 
 
 

package/dist/testing-tools.cjs

@@ -2,8 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var exports$1 = require("./exports-291eb22e.cjs");
-var spirits = require("./spirits-643c422a.cjs");
+var exports$1 = require("./exports-b2e88386.cjs");
+var spirits = require("./spirits-1dc18cf4.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.86",
+  "version": "1.0.0-alpha.0.1.88",
   "description": "Build and deploy your Scout9 app for SMS auto replies",
   "publishConfig": {
     "access": "public"

package/src/core/config/entities.js

@@ -31,12 +31,12 @@ async function loadEntityApiConfig(cwd, filePath) {
 }
 
 /**
- * @returns {Promise<EntitiesBuildConfig>}
+ * @returns {Promise<import('@scout9/app').IEntitiesRootProjectConfiguration>}
  */
 export default async function loadEntitiesConfig(
   {cwd = process.cwd(), src = 'src', logger, cb = (message) => {}} = {}
 ) {
-  /** @type EntitiesBuildConfig */
+  /** @type import('@scout9/app').IEntitiesRootProjectConfiguration */
   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});

package/src/core/config/index.js

@@ -7,8 +7,6 @@ import loadProjectConfig from './project.js';
 import loadWorkflowsConfig from './workflow.js';
 import { Scout9ProjectBuildConfigSchema } from '../../runtime/index.js';
 import { ProgressLogger } from '../../utils/index.js';
-import ProjectFiles from '../../utils/project.js';
-import { logUserValidationError } from '../../report.js';
 
 
 export function loadEnvConfig({
@@ -36,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<Scout9ProjectBuildConfig>}
+ * @returns {Promise<import('@scout9/app').IScout9ProjectBuildConfig>}
  */
 export async function loadConfig({
   cwd = process.cwd(), src = 'src', dest = '/tmp/project', deploying = false, logger = new ProgressLogger(), cb = (msg) => {
@@ -51,7 +49,7 @@ export async function loadConfig({
   const workflowsConfig = await loadWorkflowsConfig({cwd, src, logger, deploying, cb});
 
   /**
-   * @type {Scout9ProjectBuildConfig}
+   * @type {import('@scout9/app').IScout9ProjectBuildConfig}
    */
   const projectConfig = {
     ...baseProjectConfig,

package/src/core/config/project.js

@@ -35,7 +35,8 @@ async function writeImageToServer({img, type = 'icon', source}) {
 
 
 /**
- * Loads the users local package.json, if they provide a package-s9-test.json, it will load that instead (used for scout9 internal testing)
+ * Loads the users local package.json, if they provide a package-s9-test.json,
+ * it will load that instead (used for scout9 internal testing)
  * @param {cwd?: string}
  * @returns {Promise<{isTest: boolean, pkg: {name: string; version: string; dependencies: Record<string, string>}}>}
  */
@@ -54,7 +55,7 @@ export async function loadUserPackageJson({cwd = process.cwd()}) {
 }
 
 /**
- * @returns {Promise<Scout9ProjectConfig>}
+ * @returns {Promise<import('@scout9/app').IScout9ProjectConfig>}
  */
 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

@@ -1,13 +1,9 @@
 import { globSync } from 'glob';
-import path from 'node:path';
-import {
-  WorkflowConfigurationSchema,
-  WorkflowsConfigurationSchema
-} from '../../runtime/index.js';
+import { WorkflowConfigurationSchema, WorkflowsConfigurationSchema } from '../../runtime/index.js';
 
 
 /**
- * @returns {Promise<WorkflowsBuildConfig>}
+ * @returns {Promise<import('@scout9/app').IWorkflowsConfiguration>}
  */
 export default async function loadWorkflowsConfig(
   {
@@ -34,7 +30,7 @@ export default async function loadWorkflowsConfig(
     .map(({path, parents}) => {
 
       // Validate project configuration
-      /** @type {WorkflowBuildConfig} */
+      /** @type {import('@scout9/app').IWorkflowConfiguration} */
       const workflowConfig = {
         entity: parents[0],
         entities: parents.reverse(),

package/src/core/index.js

@@ -20,34 +20,6 @@ const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
 
-/**
- * @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) {
   const archive = archiver('tar', {
     gzip: true,
@@ -126,7 +98,7 @@ async function downloadAndUnpackZip(outputDir) {
  * @param {string} cwd
  * @param {string} src
  * @param {string} dest
- * @param {Scout9ProjectBuildConfig} config
+ * @param {import('@scout9/app').IScout9ProjectBuildConfig} config
  * @returns {Promise<void>}
  */
 async function buildApp(cwd, src, dest, config) {
@@ -245,6 +217,13 @@ async function downloadDevApp(destination, version) {
 
 }
 
+/**
+ * @param {Object} [options]
+ * @param {string} [options.cwd]
+ * @param {string} [options.src]
+ * @param {boolean} [options.ignoreAppRequire]
+ * @returns {Promise<{app: *, fileName: string, exe: string, filePath: string}>}
+ */
 export async function getApp({cwd = process.cwd(), src = 'src', ignoreAppRequire = false} = {}) {
   const indexTsPath = path.resolve(cwd, src, 'index.ts');
   const indexJsPath = path.resolve(cwd, src, 'index.js');
@@ -313,10 +292,10 @@ export async 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>}
  */
 export async function run(event, {eventSource} = {}) {
   const result = WorkflowEventSchema.safeParse(event);
@@ -359,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 {Scout9ProjectBuildConfig} config
+ * @param {import('../runtime/client/').IScout9ProjectBuildConfig} config
  * @returns {messages: string[]}
  */
 export async function build({
@@ -408,6 +387,7 @@ export async 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}>}
  */
 export async function deploy(
   {cwd = process.cwd(), src = './src', dest = '/tmp/project', logger = new ProgressLogger()},
@@ -455,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 {Scout9ProjectBuildConfig} config
+ * @param {import('@scout9/app').IScout9ProjectBuildConfig} config
  */
 export async function test(
   {cwd = process.cwd(), src = './src', dest = '/tmp/project', logger = new ProgressLogger()},
@@ -487,8 +467,8 @@ export async function test(
 /**
  *
  * @param {{cwd: string; src: string; projectFiles: ProjectFiles; logger: ProgressLogger}} options
- * @param {Scout9ProjectBuildConfig} config
- * @returns {Promise<{success: boolean; config: Scout9ProjectBuildConfig}>}
+ * @param {import('@scout9/app').IScout9ProjectBuildConfig} config
+ * @returns {Promise<{success: boolean; config: import('@scout9/app').IScout9ProjectBuildConfig}>}
  */
 export async function sync({
   cwd = process.cwd(), src = 'src',

package/src/core/sync.js

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

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

@@ -1,9 +1,5 @@
 import fs from 'node:fs/promises';
 import { globSync } from 'glob';
-import path from 'node:path';
-import fss from 'node:fs';
-import { checkVariableType, requireProjectFile } from '../../utils/index.js';
-
 
 
 const resolveFilePath = () => {
@@ -19,7 +15,7 @@ const resolveFilePath = () => {
 export const entities = {
   /**
    * Generates ./src/entities/
-   * @param {Scout9ProjectBuildConfig} config
+   * @param {import('@scout9/app').IScout9ProjectBuildConfig} config
    * @param {string} cwd
    * @param {string} src
    * @returns {Promise<void>}

package/src/exports.js

@@ -2,30 +2,34 @@ import { Scout9Platform } from './platform.js';
 import { EventResponse } from './runtime/index.js';
 
 export { EventResponse } from './runtime/index.js';
-// export * from './types';
+
 export * from './testing-tools/index.js';
 export * from './runtime/client/index.js';
 
 /**
- * @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>}
  */
 export async function run(event, options) {
   return Scout9Platform.run(event, options)
 }
 
 /**
- * @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>}
  */
 export const sendEvent = run;
 
 /**
  * @param data {T}
  * @param init {ResponseInit | undefined}
- * @returns {EventResponse<T>}
+ * @returns {import('./runtime/client/api.js').EventResponse<T>}
  */
 export function json(data, init) {
   if (data instanceof Promise) {