feat: make query to aibots

Author: kevinkim-ogp

packages/backend/src/apps/aibots/actions/send-query.ts

@@ -0,0 +1,51 @@
+import { IDataOutMetadata, IExecutionStep } from '@plumber/types'
+import { dataOutSchema } from './schema'
+
+async function getDataOutMetadata(
+  step: IExecutionStep,
+): Promise<IDataOutMetadata> {
+  const { dataOut: rawDataOut } = step
+
+  if (!rawDataOut) {
+    return null
+  }
+
+  dataOutSchema.parse(rawDataOut)
+
+  const metadata: IDataOutMetadata = {
+    data: {
+      response: {
+        content: {
+          label: 'Response',
+        },
+      },
+    },
+  }
+
+  // Recursively hide all fields except the ones explicitly defined in metadata
+  function hideAllFields(obj: any, metadataPath: any = {}) {
+    const result: any = { ...metadataPath }
+
+    if (obj && typeof obj === 'object' && !Array.isArray(obj)) {
+      Object.entries(obj).forEach(([key, value]) => {
+        // If this key is already defined in metadata, recurse into it
+        if (metadataPath[key]) {
+          result[key] = hideAllFields(value, metadataPath[key])
+        } else {
+          // Otherwise, hide this field
+          result[key] = { isHidden: true }
+        }
+      })
+    }
+
+    return result
+  }
+
+  const finalMetadata = hideAllFields(rawDataOut.data, metadata.data)
+
+  return {
+    data: finalMetadata,
+  }
+}
+
+export default getDataOutMetadata

packages/backend/src/apps/aibots/actions/send-query/get-data-out-metadata.ts

@@ -0,0 +1,95 @@
+import HttpError from '@/errors/http'
+import StepError, { GenericSolution } from '@/errors/step'
+import { IRawAction } from '@plumber/types'
+import { ZodError } from 'zod'
+import { fromZodError } from 'zod-validation-error'
+import getDataOutMetadata from './get-data-out-metadata'
+import { parametersSchema } from './schema'
+
+const action: IRawAction = {
+  name: 'Send Query',
+  key: 'sendQuery',
+  description: 'Sends a query to your customised AI Bot',
+  arguments: [
+    {
+      label: 'Bot API key',
+      key: 'apiKey',
+      description: 'Enter the API key for your bot',
+      type: 'string' as const,
+      required: true,
+      variables: false,
+    },
+    {
+      label: 'Query',
+      key: 'query',
+      type: 'string' as const,
+      required: true,
+      variables: true,
+    },
+  ],
+
+  getDataOutMetadata,
+
+  async run($) {
+    try {
+      const parameters = parametersSchema.parse($.step.parameters)
+
+      const { query, apiKey } = parameters
+
+      const headers = { 'X-ATLAS-Key': apiKey }
+
+      // create a new chat
+      const response = await $.http.post(
+        `/chats`,
+        { name: 'Chat from Plumber' },
+        { headers },
+      )
+
+      // /chats/:chatId/messages requires FormData
+      const chatId = response.data.id
+      const formData = new FormData()
+      formData.append('content', query)
+
+      // send the query and get the response
+      const chatResponse = await $.http.post(
+        `/chats/:chatId/messages`,
+        formData,
+        {
+          headers,
+          urlPathParams: { chatId },
+        },
+      )
+
+      $.setActionItem({
+        raw: {
+          data: chatResponse.data,
+        },
+      })
+    } catch (error) {
+      // if the user enters an invalid API key, aibots will return a 401 error
+      if (error instanceof HttpError && error.response.status === 401) {
+        throw new StepError(
+          'Invalid API key',
+          'Please check that you have entered a valid API key',
+          $.step.position,
+          $.app.name,
+        )
+      }
+
+      if (error instanceof ZodError) {
+        const firstError = fromZodError(error).details[0]
+
+        throw new StepError(
+          `${firstError.message} under set up step`,
+          GenericSolution.ReconfigureInvalidField,
+          $.step.position,
+          $.app.name,
+        )
+      }
+
+      throw error
+    }
+  },
+}
+
+export default action

packages/backend/src/apps/aibots/actions/send-query/index.ts

@@ -0,0 +1,14 @@
+import { z } from 'zod'
+
+export const parametersSchema = z.object({
+  apiKey: z.string().min(1),
+  query: z.string().min(1),
+})
+
+export const dataOutSchema = z.object({
+  data: z.object({
+    response: z.object({
+      content: z.string(),
+    }),
+  }),
+})

packages/backend/src/apps/aibots/actions/send-query/schema.ts

@@ -8,11 +8,14 @@ const app: IApp = {
   description: 'Integrate with your customised AI Bot',
   iconUrl: '{BASE_URL}/apps/aibots/assets/favicon.svg',
   authDocUrl: '',
-  baseUrl: '',
-  apiBaseUrl: '',
+  baseUrl: 'https://aibots.gov.sg',
+  apiBaseUrl: 'https://api.uat.aibots.gov.sg/v1.0/api',
   primaryColor: '',
   category: 'ai',
   // TODO: add the actual auth here
+  // there is currently no verification available for aibots
+  // its done directly in the action itself
+  // (as requested by AiBots team)
   // auth,
   actions,
 }