Merge pull request #56 from Wavely-project/routes-v1

cherry-picked the changes out of seeders

Author: 7adidaz

db/migrations/20240412003023_add_invites_table.ts

@@ -20,8 +20,8 @@ export async function up(knex: Knex): Promise<void> {
 	return knex.schema.createTable('invites', (table) => {
 		table.increments('id').primary();
 		table.integer('workspaceId').unsigned();
-		table.integer('inviteeId').unsigned();
 		table.integer('senderId').unsigned();
+		table.integer('inviteeId').unsigned();
 
 		table.timestamps(true, true, true);
 		table.timestamp('expiresAt').notNullable();

src/api-docs/openAPIDocumentGenerator.ts

@@ -1,18 +1,26 @@
 import { OpenApiGeneratorV3, OpenAPIRegistry } from '@asteasolutions/zod-to-openapi';
 
+import { channelRegistery } from '@/api/channels/channelRouter';
+import { healthCheckRegistry } from '@/api/healthCheck/healthCheckRouter';
+import { messageRegistery } from '@/api/messages/messageRouter';
 import { filesRegistry } from '@/api/files/filesRoutes';
 // import { channelRegistery } from '@/api/channels/channelRouter';
 import { healthCheckRegistry } from '@/api/healthCheck/healthCheckRouter';
 import { notificationsRegistry } from '@/api/notifications/notificationsRoutes';
 import { reactionsRegistry } from '@/api/reactions/reactionsRouter';
 import { userRegistry } from '@/api/user/userRouter';
+import { workspaceRegistry } from '@/api/workspace/workspaceRouter';
 
-// import { workspaceRegistry } from '@/api/workspace/workspaceRouter';
 import { authRegistry } from '../api/auth/authRouter';
 
 export function generateOpenAPIDocument() {
 	const registry = new OpenAPIRegistry([
 		healthCheckRegistry,
+		authRegistry,
+		userRegistry,
+		workspaceRegistry,
+		channelRegistery,
+		messageRegistery,
 		userRegistry,
 		authRegistry,
 		filesRegistry,

src/api/channels/channelController.ts

@@ -0,0 +1,45 @@
+import { Request, Response } from 'express';
+
+import { CreateChannel } from './channelModel';
+
+const ChannelController = {
+	getChannelById: async (req: Request, res: Response) => {
+		const id = parseInt(req.params.id);
+		res.json({ id });
+	},
+	createChannel: async (req: Request, res: Response) => {
+		const { name, description, type, workspaceId } = req.body;
+
+		const createChannelPayload: CreateChannel = {
+			name,
+			description,
+			type,
+			workspaceId,
+			creatorId: res.locals.user.id,
+		};
+		res.json(createChannelPayload);
+	},
+	updateChannel: async (req: Request, res: Response) => {
+		const id = parseInt(req.params.id);
+		const { name, description, type } = req.body;
+		res.json({ id, name, description, type });
+	},
+	deleteChannel: async (req: Request, res: Response) => {
+		const id = parseInt(req.params.id);
+		res.json({ id });
+	},
+	getWorkspaceChannels: async (req: Request, res: Response) => {
+		const workspaceId = parseInt(req.params.id);
+		const { cursor, limit } = req.query;
+		console.log(cursor, limit, workspaceId);
+		res.json({ 1: 1 });
+	},
+	getWorkspaceThreads: async (req: Request, res: Response) => {
+		const workspaceId = parseInt(req.params.id);
+		const { cursor, limit } = req.query;
+		console.log(cursor, limit, workspaceId);
+		res.json({ 1: 1 });
+	},
+};
+
+export default ChannelController;

src/api/channels/channelModel.ts

@@ -24,6 +24,10 @@ export type CreateChannelDto = Omit<Channel, 'id' | 'createdAt' | 'updatedAt'>;
 // Input Validation for 'GET Channel /:id' endpoint
 export const GetChannelSchema = z.object({
 	params: z.object({ id: commonValidations.id }),
+	query: z.object({
+		limit: z.string().optional(),
+		cursor: z.string().optional(),
+	}),
 });
 export const CreateChannelSchema = z.object({
 	body: z.object({
@@ -33,6 +37,19 @@ export const CreateChannelSchema = z.object({
 		workspaceId: commonValidations.id,
 	}),
 });
+export const UpdateChannelSchema = z.object({
+	body: z.object({
+		name: z.string(),
+		description: z.string(),
+		type: z.enum(['public', 'private', 'direct']),
+	}),
+	params: z.object({ id: commonValidations.id }),
+});
+export const DeleteChannelSchema = z.object({
+	params: z.object({ id: commonValidations.id }),
+});
+
+export const Channels = z.array(ChannelSchema);
 
 export type DeleteChannelData = Omit<
 	Channel,

src/api/channels/channelRouter.ts

@@ -0,0 +1,149 @@
+import { OpenAPIRegistry } from '@asteasolutions/zod-to-openapi';
+import express, { Router } from 'express';
+
+import {
+	ChannelSchema,
+	CreateChannelSchema,
+	DeleteChannelSchema,
+	GetChannelSchema,
+	UpdateChannelSchema,
+} from '@/api/channels/channelModel';
+import { createApiResponse } from '@/api-docs/openAPIResponseBuilders';
+import { messageResponse } from '@/common/utils/commonResponses';
+import { validateRequest } from '@/common/utils/httpHandlers';
+
+import AuthController from '../auth/authController';
+import MembersController from '../members/memberController';
+import MessageController from '../messages/messageController';
+import { Messages } from '../messages/messageModel';
+import { Users } from '../user/userModel';
+import ChannelController from './channelController';
+
+export const channelRegistery = new OpenAPIRegistry();
+
+const bearerAuth = channelRegistery.registerComponent('securitySchemes', 'bearerAuth', {
+	type: 'http',
+	scheme: 'bearer',
+	bearerFormat: 'JWT',
+});
+
+channelRegistery.register('Channel', ChannelSchema);
+
+export const channelRouter: Router = (() => {
+	const router = express.Router();
+
+	channelRegistery.registerPath({
+		method: 'post',
+		path: '/channels',
+		tags: ['Channel'],
+		security: [{ [bearerAuth.name]: [] }],
+		request: {
+			body: {
+				content: {
+					'application/json': {
+						schema: CreateChannelSchema.shape.body,
+					},
+				},
+			},
+		},
+		responses: createApiResponse(ChannelSchema, 'Success'),
+	});
+
+	router.post(
+		'/',
+		[AuthController.authenticate, validateRequest(CreateChannelSchema)],
+		ChannelController.createChannel
+	);
+
+	/***************************************************************************** */
+	channelRegistery.registerPath({
+		method: 'get',
+		path: '/channels/{id}',
+		tags: ['Channel'],
+		security: [{ [bearerAuth.name]: [] }],
+		request: { params: GetChannelSchema.shape.params },
+		responses: createApiResponse(ChannelSchema, 'Success'),
+	});
+
+	router.get(
+		'/:id',
+		AuthController.authenticate,
+		validateRequest(GetChannelSchema),
+		ChannelController.getChannelById
+	);
+
+	/***************************************************************************** */
+	channelRegistery.registerPath({
+		method: 'patch',
+		path: '/channels/{id}',
+		tags: ['Channel'],
+		security: [{ [bearerAuth.name]: [] }],
+		request: {
+			params: UpdateChannelSchema.shape.params,
+			body: {
+				content: {
+					'application/json': {
+						schema: UpdateChannelSchema.shape.body,
+					},
+				},
+			},
+		},
+		responses: createApiResponse(ChannelSchema, 'Success'),
+	});
+
+	router.patch(
+		'/:id',
+		[AuthController.authenticate, validateRequest(UpdateChannelSchema)],
+		ChannelController.updateChannel
+	);
+
+	/***************************************************************************** */
+	channelRegistery.registerPath({
+		method: 'delete',
+		path: '/channels/{id}',
+		tags: ['Channel'],
+		security: [{ [bearerAuth.name]: [] }],
+		request: { params: GetChannelSchema.shape.params },
+		responses: createApiResponse(messageResponse, 'Success'),
+	});
+
+	router.delete(
+		'/:id',
+		[AuthController.authenticate, validateRequest(DeleteChannelSchema)],
+		ChannelController.deleteChannel
+	);
+
+	/***************************************************************************** */
+	channelRegistery.registerPath({
+		method: 'get',
+		path: '/channels/{id}/users',
+		tags: ['Channel'],
+		security: [{ bearerAuth: [] }],
+		request: { params: GetChannelSchema.shape.params },
+		responses: createApiResponse(Users, 'Success'),
+	});
+
+	router.get(
+		'/:id/users',
+		[AuthController.authenticate, validateRequest(GetChannelSchema)],
+		MembersController.getChannelUsers
+	);
+
+	/***************************************************************************** */
+	channelRegistery.registerPath({
+		method: 'get',
+		path: '/channels/{id}/messages',
+		tags: ['Channel'],
+		security: [{ bearerAuth: [] }],
+		request: { params: GetChannelSchema.shape.params, query: GetChannelSchema.shape.query },
+		responses: createApiResponse(Messages, 'Success'),
+	});
+
+	router.get(
+		'/:id/messages',
+		[AuthController.authenticate, validateRequest(GetChannelSchema)],
+		MessageController.getChannelMessages
+	);
+
+	return router;
+})();

src/api/coworkers/coworkersController.ts

@@ -0,0 +1,35 @@
+import { Request, Response } from 'express';
+
+import { CreateCoworker } from './coworkersModel';
+
+const CoworkersController = {
+	getWorkspaceUsers: async (req: Request, res: Response) => {
+		const workspaceId = parseInt(req.params.id);
+		res.json({ workspaceId });
+	},
+	getCoworkerById: async (req: Request, res: Response) => {
+		const id = parseInt(req.params.id);
+		res.json({ id });
+	},
+	createCoworker: async (req: Request, res: Response) => {
+		const userId = parseInt(req.params.userId);
+		const workspaceId = parseInt(req.params.workspaceId);
+
+		const createCoworkerPayload: CreateCoworker = {
+			userId,
+			workspaceId,
+		};
+		res.json(createCoworkerPayload);
+	},
+	updateCoworker: async (req: Request, res: Response) => {
+		const userId = parseInt(req.params.userId);
+		const workspaceId = parseInt(req.params.workspaceId);
+		res.json({ userId, workspaceId });
+	},
+	deleteCoworker: async (req: Request, res: Response) => {
+		const id = parseInt(req.params.id);
+		res.json({ id });
+	},
+};
+
+export default CoworkersController;

src/api/coworkers/coworkersModel.ts

@@ -10,17 +10,19 @@ export const BaseCoworkerSchema = z.object({
 export const CoworkerSchema = BaseCoworkerSchema.extend({
 	createdAt: z.string(),
 });
+export const CreateCoworkerSchema = z.object({
+	params: z.object({ userId: z.number(), workspaceId: z.number() }),
+});
+
+export const GetCoworkersSchema = z.object({
+	params: z.object({ workspaceId: z.number() }),
+});
 
+export const deleteCoworkerSchema = z.object({
+	params: z.object({ userId: z.number(), workspaceId: z.number() }),
+});
 export type Coworker = z.infer<typeof CoworkerSchema>;
 export type CreateCoworker = z.infer<typeof BaseCoworkerSchema>;
 export type CreateCoworkerDto = Omit<Coworker, 'createdAt'>;
 
-// Input Validation for 'GET Coworker/:id' endpoint
-export const CreateCoworkerSchema = z.object({
-	body: z.object({
-		userId: z.number(),
-		channelId: z.number(),
-	}),
-});
-
 export type CoworkerData = Coworker & { userData: User };

src/api/invites/invitesController.ts

@@ -0,0 +1,45 @@
+import db from 'db/db';
+import { Request, Response } from 'express';
+
+import { CreateInvite } from './invitesModel';
+import invitesRepository from './invitesRepository';
+
+const InvitesController = {
+	createInvite: async (req: Request, res: Response) => {
+		const { inviteeEmail, workspaceId } = req.body;
+
+		const createInvitePayload: CreateInvite = {
+			inviteeEmail,
+			workspaceId,
+			senderId: res.locals.user.id,
+			status: 'pending',
+			expiresAt: new Date(Date.now() + 200 * 60 * 60 * 1000),
+		};
+
+		const invite = await invitesRepository.createInvite(db, createInvitePayload);
+		res.json(invite);
+	},
+	getInviteById: async (req: Request, res: Response) => {
+		const id = req.params.id;
+		const invite = await invitesRepository.getInviteById(db, id);
+		res.json(invite);
+	},
+
+	getWorkspaceInvites: async (req: Request, res: Response) => {
+		const workspaceId = req.params.id;
+		const invites = await invitesRepository.getInviteByWorkspaceId(db, workspaceId);
+		res.json(invites);
+	},
+	acceptInvite: async (req: Request, res: Response) => {
+		const id = req.params.id;
+		await invitesRepository.acceptInvite(db, id);
+		res.sendStatus(200);
+	},
+	cancelInvite: async (req: Request, res: Response) => {
+		const id = req.params.id;
+		await invitesRepository.cancelInvite(db, id);
+		res.sendStatus(200);
+	},
+};
+
+export default InvitesController;