20241106 @Mookse

Version 0.0.26
Merge branch 'base' into azure-deploy-prod

Author: Mookse

inc/js/agents/system/bot-agent.mjs

@@ -8,22 +8,19 @@ async function about(ctx){
 	await ctx.render('about')
 }
 /**
- * Activate a bot for the member
- * @module
+ * Activate a specific Bot.
  * @public
- * @api no associated view
- * @param {object} ctx Koa Context object
- * @returns {object} Koa Context object
+ * @async
+ * @param {object} ctx - Koa Context object
+ * @returns {object} - Activated Response object: { bot_id, greeting, success, version, versionUpdate, }
  */
-function activateBot(ctx){
-	const { avatar, } = ctx.state
-	avatar.activeBotId = ctx.params.bid
-	const { activeBotId, activeBotVersion, activeBotNewestVersion, } = avatar
-	ctx.body = {
-		activeBotId,
-		activeBotVersion,
-		version: activeBotNewestVersion,
-	}
+async function activateBot(ctx){
+	const { bid, } = ctx.params
+	if(!ctx.Globals.isValidGuid(bid))
+		ctx.throw(400, `missing bot id`)
+	const { avatar: Avatar, } = ctx.state
+	const response =await Avatar.setActiveBot(bid)
+	ctx.body = response
 }
 async function alerts(ctx){
 	// @todo: put into ctx the _type_ of alert to return, system use dataservices, member use personal
@@ -34,52 +31,55 @@ async function alerts(ctx){
 		ctx.body = await ctx.state.MemberSession.alerts(ctx.request.body)
 	}
 }
+/**
+ * Manage bots for the member.
+ * @param {Koa} ctx - Koa Context object
+ * @returns {object} - Koa Context object
+ */
 async function bots(ctx){
 	const { bid, } = ctx.params // bot_id sent in url path
-	const { avatar } = ctx.state
+	const { avatar: Avatar, } = ctx.state
 	const bot = ctx.request.body
 		?? {}
 	switch(ctx.method){
 		case 'DELETE': // retire bot
 			if(!ctx.Globals.isValidGuid(bid))
 				ctx.throw(400, `missing bot id`)
-			ctx.body = await avatar.retireBot(bid)
+			ctx.body = await Avatar.retireBot(bid)
 			break
 		case 'POST': // create new bot
-			ctx.body = await avatar.createBot(bot)
+			ctx.body = await Avatar.createBot(bot)
 			break
 		case 'PUT': // update bot
-			ctx.body = await avatar.updateBot(bot)
+			ctx.body = await Avatar.updateBot(bot)
 			break
 		case 'GET':
 		default:
 			if(bid?.length){ // specific bot
-				ctx.body = await avatar.getBot(ctx.params.bid)
+				ctx.body = await Avatar.getBot(ctx.params.bid)
 			} else {
-				const { activeBotId, } = avatar
-				const bots = await avatar.getBots()
+				const bots = await Avatar.getBots()
+				let { activeBotId, greeting, } = Avatar
+				if(!activeBotId){
+					const { bot_id, greeting: activeGreeting } = await Avatar.setActiveBot()
+					activeBotId = bot_id
+					greeting = activeGreeting
+				}
 				ctx.body = { // wrap bots
 					activeBotId,
 					bots,
+					greeting,
 				}
 			}
 			break
 	}
 }
-function category(ctx){ // sets category for avatar
-	ctx.state.category = ctx.request.body
-	const { avatar, } = ctx.state
-	avatar.setActiveCategory(ctx.state.category)
-	ctx.body = avatar.category
-}
 /**
  * Challenge the member session with a passphrase.
- * @module
  * @public
  * @async
- * @api - No associated view
  * @param {Koa} ctx - Koa Context object
- * @returns {object} Koa Context object
+ * @returns {object} - Koa Context object
  * @property {object} ctx.body - The result of the challenge.
  */
 async function challenge(ctx){
@@ -99,6 +99,8 @@ async function challenge(ctx){
 }
 /**
  * Chat with the Member or System Avatar's intelligence.
+ * @public
+ * @async
  * @param {Koa} ctx - Koa Context object
  * @returns {object} - The response from the chat in `ctx.body`
  * @property {object} instruction - Instructionset for the frontend to execute (optional)
@@ -131,41 +133,38 @@ async function createBot(ctx){
 	ctx.body = await avatar.createBot(bot)
 }
 /**
- * Delete an item from collection via the member's avatar.
- * @async
- * @public
- * @param {object} ctx - Koa Context object
- * @returns {boolean} - Under `ctx.body`, status of deletion.
+ * Save feedback from the member.
+ * @param {Koa} ctx - Koa Context object
+ * @returns {Boolean} - Whether or not the feedback was saved
  */
-async function deleteItem(ctx){
-	const { iid, } = ctx.params
-	const { avatar, } = ctx.state
-	if(!iid?.length)
-		ctx.throw(400, `missing item id`)
-	ctx.body = await avatar.deleteItem(iid)
+async function feedback(ctx){
+	const { mid: message_id, } = ctx.params
+	const { avatar: Avatar, } = ctx.state
+	const { isPositive=true, message, } = ctx.request.body
+	ctx.body = await Avatar.feedback(message_id, isPositive, message)
 }
 /**
- * Get greetings for this bot/active bot.
- * @todo - move dynamic system responses to a separate function (route /system)
- * @param {Koa} ctx - Koa Context object.
- * @returns {object} - Greetings response message object: { success: false, messages: [], }.
+ * Get greetings for active situation.
+ * @public
+ * @async
+ * @param {Koa} ctx - Koa Context object
+ * @returns {object} - Greetings response message object: { responses, success, }
  */
 async function greetings(ctx){
 	const { vld: validateId, } = ctx.request.query
 	let { dyn: dynamic, } = ctx.request.query
 	if(typeof dynamic==='string')
 		dynamic = JSON.parse(dynamic)
-	const { avatar, } = ctx.state
-	let response = { success: false, messages: [], }
-	if(validateId?.length)
-		response.messages.push(...await avatar.validateRegistration(validateId))
-	else
-		response.messages.push(...await avatar.greeting(dynamic))
-	response.success = response.messages.length > 0
+	const { avatar: Avatar, } = ctx.state
+	const response = validateId?.length && Avatar.isMyLife
+		? await Avatar.validateRegistration(validateId)
+		: await Avatar.greeting(dynamic)
 	ctx.body = response
 }
 /**
  * Request help about MyLife.
+ * @public
+ * @async
  * @param {Koa} ctx - Koa Context object, body={ request: string|required, mbr_id, type: string, }.
  * @returns {object} - Help response message object.
  */
@@ -179,8 +178,8 @@ async function help(ctx){
 }
 /**
  * Index page for the application.
- * @async
  * @public
+ * @async
  * @param {object} ctx - Koa Context object
  */
 async function index(ctx){
@@ -210,18 +209,12 @@ async function item(ctx){
 	const { avatar, } = ctx.state
 	const { globals, } = avatar
 	const { method, } = ctx.request
-	const item = ctx.request.body
-	/* validate payload */
-	if(!id?.length)
-		ctx.throw(400, `missing item id`)
-	if(!item || typeof item !== 'object' || !Object.keys(item).length)
-		ctx.throw(400, `missing item data`)
-	const { id: itemId, } = item
-	if(itemId && itemId!==id) // ensure item.id is set to id
-		throw new Error(`item.id must match /:iid`)
-	else if(!itemId)
+	const item = ctx.request.body // always `{}` by default
+	if(!item?.id && id?.length)
 		item.id = id
-	ctx.body = await avatar.item(item, method)
+	const response = await avatar.item(item, method)
+	delete avatar.frontendInstruction // already embedded in response
+	ctx.body = response
 }
 async function logout(ctx){
 	ctx.session = null
@@ -354,17 +347,15 @@ async function signup(ctx) {
 	const { mbr_id, ..._registrationData } = signupPacket // do not display theoretical memberId
     ctx.status = 200 // OK
     ctx.body = {
+		message: 'Signup successful',
 		payload: _registrationData,
         success,
-        message: 'Signup successful',
     }
 }
 async function summarize(ctx){
-	const { avatar, } = ctx.state
+	const { avatar: Avatar, } = ctx.state
 	const { fileId, fileName, } = ctx.request.body
-	if(avatar.isMyLife)
-		throw new Error('Only logged in members may summarize text')
-	ctx.body = await avatar.summarize(fileId, fileName)
+	ctx.body = await Avatar.summarize(fileId, fileName)
 }
 /**
  * Get a specified team, its details and bots, by id for the member.
@@ -384,8 +375,8 @@ async function team(ctx){
  * @returns {Object[]} - List of team objects.
  */
 async function teams(ctx){
-	const { avatar, } = ctx.state
-	ctx.body = await avatar.teams()
+	const { avatar: Avatar, } = ctx.state
+	ctx.body = await Avatar.teams()
 }
 async function updateBotInstructions(ctx){
 	const { bid, } = ctx.params
@@ -417,14 +408,13 @@ export {
 	activateBot,
 	alerts,
 	bots,
-	category,
 	challenge,
 	chat,
 	collections,
 	createBot,
-	deleteItem,
-	help,
+	feedback,
 	greetings,
+	help,
 	index,
 	interfaceMode,
 	item,