From 5e781206234cf5e2d8415617904d65130007f3cb Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Fri, 28 Feb 2025 16:12:26 +0100 Subject: [PATCH] feat: Implement admin get templates API endpoint --- .../v1/admin/templates/get-templates.ee.js | 10 ++++++ .../admin/templates/get-templates.ee.test.js | 36 +++++++++++++++++++ .../src/routes/api/v1/admin/templates.ee.js | 9 +++++ .../v1/admin/templates/get-templates.ee.js | 22 ++++++++++++ 4 files changed, 77 insertions(+) create mode 100644 packages/backend/src/controllers/api/v1/admin/templates/get-templates.ee.js create mode 100644 packages/backend/src/controllers/api/v1/admin/templates/get-templates.ee.test.js create mode 100644 packages/backend/test/mocks/rest/api/v1/admin/templates/get-templates.ee.js diff --git a/packages/backend/src/controllers/api/v1/admin/templates/get-templates.ee.js b/packages/backend/src/controllers/api/v1/admin/templates/get-templates.ee.js new file mode 100644 index 00000000..4f5ffa54 --- /dev/null +++ b/packages/backend/src/controllers/api/v1/admin/templates/get-templates.ee.js @@ -0,0 +1,10 @@ +import { renderObject } from '../../../../../helpers/renderer.js'; +import Template from '../../../../../models/template.ee.js'; + +export default async (request, response) => { + const templates = await Template.query().orderBy('created_at', 'asc'); + + renderObject(response, templates, { + serializer: 'AdminTemplate', + }); +}; diff --git a/packages/backend/src/controllers/api/v1/admin/templates/get-templates.ee.test.js b/packages/backend/src/controllers/api/v1/admin/templates/get-templates.ee.test.js new file mode 100644 index 00000000..c0666871 --- /dev/null +++ b/packages/backend/src/controllers/api/v1/admin/templates/get-templates.ee.test.js @@ -0,0 +1,36 @@ +import { vi, describe, it, expect, beforeEach } from 'vitest'; +import request from 'supertest'; +import app from '../../../../../app.js'; +import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js'; +import { createRole } from '../../../../../../test/factories/role.js'; +import { createUser } from '../../../../../../test/factories/user.js'; +import { createTemplate } from '../../../../../../test/factories/template.js'; +import getTemplatesMock from '../../../../../../test/mocks/rest/api/v1/admin/templates/get-templates.ee.js'; +import * as license from '../../../../../helpers/license.ee.js'; + +describe('GET /api/v1/admin/templates', () => { + let currentUser, token, role; + + beforeEach(async () => { + vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true); + + role = await createRole({ name: 'Admin' }); + currentUser = await createUser({ roleId: role.id }); + + token = await createAuthTokenByUserId(currentUser.id); + }); + + it('should return templates', async () => { + const templateOne = await createTemplate(); + const templateTwo = await createTemplate(); + + const response = await request(app) + .get('/api/v1/admin/templates') + .set('Authorization', token) + .expect(200); + + const expectedPayload = await getTemplatesMock([templateOne, templateTwo]); + + expect(response.body).toStrictEqual(expectedPayload); + }); +}); diff --git a/packages/backend/src/routes/api/v1/admin/templates.ee.js b/packages/backend/src/routes/api/v1/admin/templates.ee.js index 34b5c137..896e379e 100644 --- a/packages/backend/src/routes/api/v1/admin/templates.ee.js +++ b/packages/backend/src/routes/api/v1/admin/templates.ee.js @@ -4,9 +4,18 @@ import { authorizeAdmin } from '../../../../helpers/authorization.js'; import { checkIsEnterprise } from '../../../../helpers/check-is-enterprise.js'; import createTemplateAction from '../../../../controllers/api/v1/admin/templates/create-template.ee.js'; +import getTemplatesAction from '../../../../controllers/api/v1/admin/templates/get-templates.ee.js'; const router = Router(); +router.get( + '/', + authenticateUser, + authorizeAdmin, + checkIsEnterprise, + getTemplatesAction +); + router.post( '/', authenticateUser, diff --git a/packages/backend/test/mocks/rest/api/v1/admin/templates/get-templates.ee.js b/packages/backend/test/mocks/rest/api/v1/admin/templates/get-templates.ee.js new file mode 100644 index 00000000..673729fa --- /dev/null +++ b/packages/backend/test/mocks/rest/api/v1/admin/templates/get-templates.ee.js @@ -0,0 +1,22 @@ +const getTemplatesMock = async (templates) => { + const data = templates.map((template) => ({ + id: template.id, + name: template.name, + createdAt: template.createdAt.getTime(), + updatedAt: template.updatedAt.getTime(), + flowData: template.flowData, + })); + + return { + data: data, + meta: { + count: data.length, + currentPage: null, + isArray: true, + totalPages: null, + type: 'Template', + }, + }; +}; + +export default getTemplatesMock;