feat: Introduce app serializer

packages/backend/src/controllers/api/v1/apps/get-app.js

@@ -4,5 +4,5 @@ import { renderObject } from '../../../../helpers/renderer.js';
 export default async (request, response) => {
   const app = await App.findOneByKey(request.params.appKey);
 
-  renderObject(response, app);
+  renderObject(response, app, { serializer: 'App' });
 };

packages/backend/src/controllers/api/v1/apps/get-app.test.js

@@ -1,5 +1,6 @@
 import { describe, it, expect, beforeEach } from 'vitest';
 import request from 'supertest';
+import App from '../../../../models/app';
 import app from '../../../../app.js';
 import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id';
 import { createUser } from '../../../../../test/factories/user';
@@ -14,12 +15,14 @@ describe('GET /api/v1/apps/:appKey', () => {
   });
 
   it('should return the app info', async () => {
+    const exampleApp = await App.findOneByKey('github');
+
     const response = await request(app)
-      .get('/api/v1/apps/github')
+      .get(`/api/v1/apps/${exampleApp.key}`)
       .set('Authorization', token)
       .expect(200);
 
-    const expectedPayload = getAppMock('github');
+    const expectedPayload = getAppMock(exampleApp);
     expect(response.body).toEqual(expectedPayload);
   });
 

packages/backend/src/serializers/app.js

@@ -0,0 +1,12 @@
+const appSerializer = (app) => {
+  return {
+    name: app.name,
+    key: app.key,
+    iconUrl: app.iconUrl,
+    authDocUrl: app.authDocUrl,
+    supportsConnections: app.supportsConnections,
+    primaryColor: app.primaryColor,
+  };
+};
+
+export default appSerializer;

packages/backend/src/serializers/app.test.js

@@ -0,0 +1,20 @@
+import { describe, it, expect } from 'vitest';
+import App from '../models/app';
+import appSerializer from './app';
+
+describe('appSerializer', () => {
+  it('should return permission data', async () => {
+    const app = await App.findOneByKey('deepl');
+
+    const expectedPayload = {
+      name: app.name,
+      key: app.key,
+      iconUrl: app.iconUrl,
+      authDocUrl: app.authDocUrl,
+      supportsConnections: app.supportsConnections,
+      primaryColor: app.primaryColor,
+    };
+
+    expect(appSerializer(app)).toEqual(expectedPayload);
+  });
+});

packages/backend/src/serializers/index.js

@@ -5,6 +5,7 @@ import samlAuthProviderSerializer from './saml-auth-provider.ee.js';
 import appAuthClientSerializer from './app-auth-client.js';
 import flowSerializer from './flow.js';
 import stepSerializer from './step.js';
+import appSerializer from './app.js';
 
 const serializers = {
   User: userSerializer,
@@ -14,6 +15,7 @@ const serializers = {
   AppAuthClient: appAuthClientSerializer,
   Flow: flowSerializer,
   Step: stepSerializer,
+  App: appSerializer,
 };
 
 export default serializers;