fix(integrations/trello): add missing titles & descriptions (botpress#14928)

Author: JustinBordage

integrations/trello/definitions/actions/board-actions.ts

@@ -1,6 +1,6 @@
 import { ActionDefinition, z } from '@botpress/sdk'
 import { boardSchema } from 'definitions/schemas'
-import { hasBoardId, noInput, outputsBoard, outputsBoards } from './common'
+import { hasBoardId, noInput } from './common'
 
 export const getBoardById = {
   title: 'Get board by ID',
@@ -9,7 +9,9 @@ export const getBoardById = {
     schema: hasBoardId.describe('Input schema for getting a board from its ID'),
   },
   output: {
-    schema: outputsBoard.describe('Output schema for getting a board from its ID'),
+    schema: z.object({
+      board: boardSchema.title('Trello Board').describe('The details of the Trello board associated with the given ID'),
+    }),
   },
 } as const satisfies ActionDefinition
 
@@ -24,7 +26,12 @@ export const getBoardsByDisplayName = {
       .describe('Input schema for getting a board ID from its name'),
   },
   output: {
-    schema: outputsBoards.describe('Output schema for getting a board from its name'),
+    schema: z.object({
+      boards: z
+        .array(boardSchema)
+        .title('Trello Boards')
+        .describe('A list of boards that match the given display name'),
+    }),
   },
 } as const satisfies ActionDefinition
 
@@ -35,6 +42,8 @@ export const getAllBoards = {
     schema: noInput.describe('Input schema for getting all boards'),
   },
   output: {
-    schema: outputsBoards.describe('Output schema for getting all boards'),
+    schema: z.object({
+      boards: z.array(boardSchema).title('Trello Boards').describe('A list of Trello boards'),
+    }),
   },
 } as const satisfies ActionDefinition

integrations/trello/definitions/actions/card-actions.ts

@@ -1,6 +1,6 @@
 import { ActionDefinition, z } from '@botpress/sdk'
 import { cardSchema, listSchema, trelloIdSchema } from 'definitions/schemas'
-import { hasCardId, hasListId, hasMessage, outputsCard, outputsCards } from './common'
+import { hasCardId, hasListId, hasMessage } from './common'
 
 export const getCardById = {
   title: 'Get card by ID',
@@ -9,13 +9,15 @@ export const getCardById = {
     schema: hasCardId.describe('Input schema for getting a card from its ID'),
   },
   output: {
-    schema: outputsCard.describe('Output schema for getting a card from its ID'),
+    schema: z.object({
+      card: cardSchema.title('Trello Card').describe("The Trello card that's associated with the given card ID"),
+    }),
   },
 } as const satisfies ActionDefinition
 
 export const getCardsByDisplayName = {
-  title: 'Find cards by name name',
-  description: 'Find all lists whose display name match this name',
+  title: 'Find cards by name',
+  description: 'Find all cards whose display name match this name',
   input: {
     schema: hasListId
       .extend({
@@ -24,7 +26,9 @@ export const getCardsByDisplayName = {
       .describe('Input schema for getting a card ID from its name'),
   },
   output: {
-    schema: outputsCards.describe('Output schema for getting a card ID from its name'),
+    schema: z.object({
+      cards: z.array(cardSchema).title('Trello Cards').describe('A list of cards that match the given card name'),
+    }),
   },
 } as const satisfies ActionDefinition
 
@@ -35,7 +39,12 @@ export const getCardsInList = {
     schema: hasListId.describe('Input schema for getting all cards in a list'),
   },
   output: {
-    schema: outputsCards.describe('Output schema for getting all cards in a list'),
+    schema: z.object({
+      cards: z
+        .array(cardSchema)
+        .title('Trello Cards')
+        .describe('An array of cards that are contained within the given list'),
+    }),
   },
 } as const satisfies ActionDefinition
 
@@ -73,8 +82,11 @@ export const createCard = {
       .describe('Input schema for creating a new card'),
   },
   output: {
-    schema: hasMessage
-      .extend({
+    schema: z
+      .object({
+        message: hasMessage.shape.message
+          .title('Action message')
+          .describe('A message that says if the card was successfully created or not'),
         newCardId: cardSchema.shape.id.describe('Unique identifier of the new card'),
       })
       .describe('Output schema for creating a card'),
@@ -201,11 +213,13 @@ export const addCardComment = {
       .describe('Input schema for adding a comment to a card'),
   },
   output: {
-    schema: hasMessage
-      .extend({
-        newCommentId: trelloIdSchema.describe('Unique identifier of the newly created comment'),
-      })
-      .describe('Output schema for adding a comment to a card'),
+    schema: z.object({
+      message: z
+        .string()
+        .title('Action message')
+        .describe('A message that says if the comment was successfully created or not'),
+      newCommentId: trelloIdSchema.title('New Comment ID').describe('Unique identifier of the newly created comment'),
+    }),
   },
 } as const satisfies ActionDefinition
 

integrations/trello/definitions/actions/common.ts

@@ -1,5 +1,5 @@
 import { z } from '@botpress/sdk'
-import { boardSchema, listSchema, cardSchema, memberSchema } from 'definitions/schemas'
+import { boardSchema, listSchema, cardSchema } from 'definitions/schemas'
 
 // ==== Common Input Schemas ====
 export const noInput = z.object({})
@@ -18,37 +18,5 @@ export const hasCardId = z.object({
 
 // ==== Common Output Schemas ====
 export const hasMessage = z.object({
-  message: z.string().describe('Output message'),
-})
-
-export const outputsMember = z.object({
-  member: memberSchema.describe('The member object'),
-})
-
-export const outputsMembers = z.object({
-  members: z.array(memberSchema).describe('Array of member objects'),
-})
-
-export const outputsCard = z.object({
-  card: cardSchema.describe('The card object'),
-})
-
-export const outputsCards = z.object({
-  cards: z.array(cardSchema).describe('Array of card objects'),
-})
-
-export const outputsList = z.object({
-  list: listSchema.describe('The list object'),
-})
-
-export const outputsLists = z.object({
-  lists: z.array(listSchema).describe('Array of list objects'),
-})
-
-export const outputsBoard = z.object({
-  board: boardSchema.describe('The board object'),
-})
-
-export const outputsBoards = z.object({
-  boards: z.array(boardSchema).describe('Array of board objects'),
+  message: z.string().title('Output message').describe('Output message'),
 })

integrations/trello/definitions/actions/list-actions.ts

@@ -1,6 +1,6 @@
-import { ActionDefinition } from '@botpress/sdk'
+import { ActionDefinition, z } from '@botpress/sdk'
 import { listSchema } from 'definitions/schemas'
-import { hasBoardId, hasListId, outputsList, outputsLists } from './common'
+import { hasBoardId, hasListId } from './common'
 
 export const getListById = {
   title: 'Get list by ID',
@@ -9,7 +9,9 @@ export const getListById = {
     schema: hasListId.describe('Input schema for getting a list from its ID'),
   },
   output: {
-    schema: outputsList.describe('Output schema for getting a list from its ID'),
+    schema: z.object({
+      list: listSchema.title('Trello List').describe("The Trello list that's associated with the given list ID"),
+    }),
   },
 } as const satisfies ActionDefinition
 
@@ -24,7 +26,12 @@ export const getListsByDisplayName = {
       .describe('Input schema for getting a list ID from its name'),
   },
   output: {
-    schema: outputsLists.describe('Output schema for getting a list ID from its name'),
+    schema: z.object({
+      lists: z
+        .array(listSchema)
+        .title('Trello Lists')
+        .describe('A set of lists that are associated with the given board ID and match the given display name'),
+    }),
   },
 } as const satisfies ActionDefinition
 
@@ -35,6 +42,11 @@ export const getListsInBoard = {
     schema: hasBoardId.describe('Input schema for getting all lists in a board'),
   },
   output: {
-    schema: outputsLists.describe('Output schema for getting all lists in a board'),
+    schema: z.object({
+      lists: z
+        .array(listSchema)
+        .title('Trello Lists')
+        .describe('A set of all the lists that are associated with the given board ID'),
+    }),
   },
 } as const satisfies ActionDefinition

integrations/trello/definitions/actions/member-actions.ts

@@ -1,6 +1,6 @@
 import { ActionDefinition, z } from '@botpress/sdk'
 import { boardSchema, memberSchema } from 'definitions/schemas'
-import { hasBoardId, hasCardId, outputsMember, outputsMembers } from './common'
+import { hasBoardId, hasCardId } from './common'
 
 export const getMemberByIdOrUsername = {
   title: 'Get member by ID or username',
@@ -16,7 +16,11 @@ export const getMemberByIdOrUsername = {
       .describe('Input schema for getting a member from its ID or username'),
   },
   output: {
-    schema: outputsMember.describe('Output schema for getting a member by its ID or username'),
+    schema: z.object({
+      member: memberSchema
+        .title('Trello Member')
+        .describe('The Trello member who is associated with the specified member ID or username'),
+    }),
   },
 } as const satisfies ActionDefinition
 
@@ -27,7 +31,12 @@ export const getAllCardMembers = {
     schema: hasCardId.describe('Input schema for getting all members of a card'),
   },
   output: {
-    schema: outputsMembers.describe('Output schema for getting all members of a card'),
+    schema: z.object({
+      members: z
+        .array(memberSchema)
+        .title('Card Members')
+        .describe('A list of members who have been assigned to the card'),
+    }),
   },
 } as const satisfies ActionDefinition
 
@@ -38,21 +47,23 @@ export const getAllBoardMembers = {
     schema: hasBoardId.describe('Input schema for getting all members of a board'),
   },
   output: {
-    schema: outputsMembers.describe('Output schema for getting all members of a board'),
+    schema: z.object({
+      members: z.array(memberSchema).title('Board Members').describe('A list of members who have access to the board'),
+    }),
   },
 } as const satisfies ActionDefinition
 
 export const getBoardMembersByDisplayName = {
   title: 'Get members by name',
   description: 'Find all members whose display name match this name',
   input: {
-    schema: hasBoardId
-      .extend({
-        displayName: boardSchema.shape.name.title('Display Name').describe('Display name of the member'),
-      })
-      .describe('Input schema for getting a member from its name'),
+    schema: hasBoardId.extend({
+      displayName: boardSchema.shape.name.title('Display Name').describe('Display name of the member'),
+    }),
   },
   output: {
-    schema: outputsMembers.describe('Output schema for getting a member from its name'),
+    schema: z.object({
+      members: z.array(memberSchema).title('Board Members').describe('A list of members that match the specified name'),
+    }),
   },
 } as const satisfies ActionDefinition

integrations/trello/integration.definition.ts

@@ -5,7 +5,7 @@ import { trelloIdSchema } from 'definitions/schemas'
 import { events, actions, channels, user, configuration, entities } from './definitions'
 
 export const INTEGRATION_NAME = 'trello'
-export const INTEGRATION_VERSION = '2.1.1'
+export const INTEGRATION_VERSION = '2.1.2'
 
 export default new sdk.IntegrationDefinition({
   name: INTEGRATION_NAME,