feat/EXT-6729/app-action-createWithResult (#10108)

fix: better schema validation with CMA changes

- Upgrade CMA to version 11.58.1
- `AppActionCall.sys.result` and `AppActionCall.sys.error` exist when `AppActionCall.sys.status` exist. CMA changes are [here](contentful/contentful-management.js#2758).
- Use typebox schemas for better assertions and schema validation
- Corresponding unit tests for validations

Author: michaelpineirocontentful

apps/microsoft-teams/.npmrc

@@ -0,0 +1 @@
+@contentful:registry=https://registry.npmjs.org/

apps/microsoft-teams/app-actions/.npmrc

@@ -0,0 +1 @@
+@contentful:registry=https://registry.npmjs.org/

apps/microsoft-teams/app-actions/package-lock.json

@@ -13,7 +13,7 @@
   },
   "dependencies": {
     "@contentful/node-apps-toolkit": "^2.6.0",
-    "contentful-management": "^11.38.0",
+    "contentful-management": "^11.56.0",
     "mocha": "^10.8.2",
     "sinon": "^19.0.2"
   },

apps/microsoft-teams/app-actions/package.json

@@ -4,14 +4,12 @@ import sinonChai from 'sinon-chai';
 import { AppInstallationProps } from 'contentful-management';
 import { AppActionCallContext } from '@contentful/node-apps-toolkit';
 import {
-  AppActionCallResponseError,
-  AppActionCallResponseSuccess,
   EntryActivity,
   SendEntryActivityMessageResult,
   MsTeamsBotServiceResponse,
-  MessageResponse,
   SendWorkflowUpdateMessageResult,
 } from '../types';
+import { MessageResponse, AppActionResultSuccess, AppActionResultError } from '../../../types';
 import { makeMockAppActionCallContext, mockAppInstallation, mockEntry } from '../../test/mocks';
 import { handler } from './handle-app-event';
 import helpers from '../helpers';
@@ -53,7 +51,7 @@ describe('handle-app-event.handler', () => {
         eventDatetime: '2024-01-18T21:43:54.267Z',
       },
       context
-    )) as AppActionCallResponseSuccess<SendEntryActivityMessageResult[]>;
+    )) as AppActionResultSuccess<SendEntryActivityMessageResult[]>;
 
     expect(result).to.have.property('ok', true);
     expect(result.data).to.deep.include({
@@ -89,7 +87,7 @@ describe('handle-app-event.handler', () => {
             eventDatetime: '2024-01-18T21:43:54.267Z',
           },
           context
-        )) as AppActionCallResponseSuccess<SendWorkflowUpdateMessageResult>;
+        )) as AppActionResultSuccess<SendWorkflowUpdateMessageResult>;
 
         expect(result.ok).to.equal(true);
         expect(result.data.sendWorkflowUpdateResult.ok).to.equal(true);
@@ -113,7 +111,7 @@ describe('handle-app-event.handler', () => {
           eventDatetime: '2024-01-18T21:43:54.267Z',
         },
         context
-      )) as AppActionCallResponseError;
+      )) as AppActionResultError;
 
       expect(result).to.have.property('ok', false);
       expect(result.error).to.have.property('type', 'Error');

apps/microsoft-teams/app-actions/src/actions/handle-app-event.spec.ts

@@ -1,13 +1,13 @@
 import { AppActionCallContext } from '@contentful/node-apps-toolkit';
 import {
-  AppActionCallResponse,
   EntryActivityMessage,
   SendEntryActivityMessageResult,
   SendWorkflowUpdateMessageResult,
   Topic,
   WorkflowPayload,
   WorkflowUpdateMessage,
 } from '../types';
+import { AppActionResult } from '../../../types';
 import { EntryProps } from 'contentful-management/types';
 import helpers from '../helpers';
 import { parametersFromAppInstallation } from '../helpers/app-installation';
@@ -26,7 +26,7 @@ export const handler = withAsyncAppActionErrorHandling(
     parameters: AppActionCallParameters,
     context: AppActionCallContext
   ): Promise<
-    AppActionCallResponse<SendEntryActivityMessageResult[] | SendWorkflowUpdateMessageResult>
+    AppActionResult<SendEntryActivityMessageResult[] | SendWorkflowUpdateMessageResult>
   > => {
     const {
       cma,

apps/microsoft-teams/app-actions/src/actions/handle-app-event.ts

@@ -4,7 +4,8 @@ import sinonChai from 'sinon-chai';
 import { AppInstallationProps, SysLink } from 'contentful-management';
 import { AppActionCallContext } from '@contentful/node-apps-toolkit';
 import { handler } from './list-channels';
-import { AppActionCallResponseSuccess, Channel } from '../types';
+import { AppActionResultSuccess } from '../../../types';
+import { Channel } from '../../../types';
 import { makeMockAppActionCallContext, mockChannels } from '../../test/mocks';
 import helpers from '../helpers';
 
@@ -22,6 +23,7 @@ describe('listChannels.handler', () => {
         appDefinition: {} as SysLink,
         environment: {} as SysLink,
         space: {} as SysLink,
+        organization: {} as SysLink,
         version: 1,
         createdAt: 'createdAt',
         updatedAt: 'updatedAt',
@@ -44,7 +46,7 @@ describe('listChannels.handler', () => {
         tenantId,
       },
       context
-    )) as AppActionCallResponseSuccess<Channel[]>;
+    )) as AppActionResultSuccess<Channel[]>;
 
     expect(result).to.have.property('ok', true);
     expect(result).to.have.property('data', mockChannels);

apps/microsoft-teams/app-actions/src/actions/list-channels.spec.ts

@@ -1,22 +1,20 @@
 import { AppActionCallContext } from '@contentful/node-apps-toolkit';
-import { AppActionCallResponse, Channel } from '../types';
+import { AppActionResult, Channel } from '../../../types';
 import { fetchTenantId } from '../utils';
 import helpers from '../helpers';
 import { withAsyncAppActionErrorHandling } from '../helpers/error-handling';
 
 export const handler = withAsyncAppActionErrorHandling(
-  async (
-    _payload: {},
-    context: AppActionCallContext
-  ): Promise<AppActionCallResponse<Channel[]>> => {
+  async (_payload: {}, context: AppActionCallContext): Promise<AppActionResult<Channel[]>> => {
     const {
       cma,
-      appActionCallContext: { appInstallationId, userId, environmentId, spaceId },
+      appActionCallContext: { appInstallationId: appDefinitionId, userId, environmentId, spaceId },
     } = context;
 
-    const tenantId = await fetchTenantId(cma, appInstallationId);
-    const channels = await helpers.getChannelsList(tenantId, {
-      appInstallationId,
+    const tenantId = await fetchTenantId(cma, appDefinitionId);
+    let channels: Channel[] = [];
+    channels = await helpers.getChannelsList(tenantId, {
+      appInstallationId: appDefinitionId,
       userId,
       environmentId,
       spaceId,

apps/microsoft-teams/app-actions/src/actions/list-channels.ts

@@ -9,8 +9,8 @@ import {
   AppInstallationProps,
 } from 'contentful-management';
 import { AppActionCallContext } from '@contentful/node-apps-toolkit';
-import helpers from '../helpers';
-import { AppActionCallResponseSuccess, MessageResponse, MsTeamsBotServiceResponse } from '../types';
+import { MsTeamsBotServiceResponse } from '../types';
+import { AppActionResultSuccess, MessageResponse } from '../../../types';
 import { MsTeamsBotService } from '../services/msteams-bot-service';
 import { config } from '../config';
 
@@ -51,6 +51,7 @@ describe('sendTestMessage.handler', () => {
         appDefinition: {} as SysLink,
         environment: {} as SysLink,
         space: {} as SysLink,
+        organization: {} as SysLink,
         version: 1,
         createdAt: 'createdAt',
         updatedAt: 'updatedAt',
@@ -78,10 +79,7 @@ describe('sendTestMessage.handler', () => {
   });
 
   it('returns the ok result', async () => {
-    const result = (await handler(
-      parameters,
-      context
-    )) as AppActionCallResponseSuccess<MessageResponse>;
+    const result = (await handler(parameters, context)) as AppActionResultSuccess<MessageResponse>;
     expect(result).to.have.property('ok', true);
     expect(result.data).to.have.property('messageResponseId', 'message-response-id');
   });

apps/microsoft-teams/app-actions/src/actions/send-test.spec.ts

@@ -1,5 +1,5 @@
 import { AppActionCallContext } from '@contentful/node-apps-toolkit';
-import { AppActionCallResponse, MessageResponse } from '../types';
+import { AppActionResult, MessageResponse } from '../../../types';
 import { fetchTenantId } from '../utils';
 import { config } from '../config';
 import { withAsyncAppActionErrorHandling } from '../helpers/error-handling';
@@ -14,7 +14,7 @@ export const handler = withAsyncAppActionErrorHandling(
   async (
     payload: AppActionCallParameters,
     context: AppActionCallContext
-  ): Promise<AppActionCallResponse<MessageResponse>> => {
+  ): Promise<AppActionResult<MessageResponse>> => {
     const { channelId, teamId, contentTypeId } = payload;
     const {
       cma,