Merge pull request hngprojects#480 from Ibrahim4Grace/create-org

feat: create organization

src/controllers/OrgController.ts

@@ -10,7 +10,7 @@ export class OrgController {
 
   /**
    * @swagger
-   * /api/v1/organisations:
+   * /api/v1/organizations:
    *   post:
    *     summary: Create a new organisation
    *     description: This endpoint allows a user to create a new organisation
@@ -44,6 +44,9 @@ export class OrgController {
    *               country:
    *                 type: string
    *                 example: Nigeria
+   *               address:
+   *                 type: string
+   *                 example: 121 ikeja
    *               state:
    *                 type: string
    *                 example: Oyo
@@ -54,6 +57,7 @@ export class OrgController {
    *               - industry
    *               - type
    *               - country
+   *               - address
    *               - state
    *     responses:
    *       '201':
@@ -93,6 +97,9 @@ export class OrgController {
    *                     country:
    *                       type: string
    *                       example: Nigeria
+   *                     address:
+   *                       type: string
+   *                       example: 121 ikeja
    *                     state:
    *                       type: string
    *                       example: Oyo
@@ -149,8 +156,6 @@ export class OrgController {
    *       type: http
    *       scheme: bearer
    *       bearerFormat: JWT
-   *
-   *
    */
 
   async createOrganisation(req: Request, res: Response, next: NextFunction) {
@@ -160,15 +165,15 @@ export class OrgController {
       const userId = user.id;
 
       const organisationService = new OrgService();
-      const newOrganisation = await organisationService.createOrganisation(
+      const new_organisation = await organisationService.createOrganisation(
         payload,
         userId,
       );
 
       const respObj = {
         status: "success",
         message: "organisation created successfully",
-        data: newOrganisation,
+        data: new_organisation,
         status_code: 201,
       };
 
@@ -180,7 +185,7 @@ export class OrgController {
 
   /**
    * @swagger
-   * /api/v1/users/{userId}/organisations:
+   * /api/v1/users/{userId}/organizations:
    *   get:
    *     summary: Get user organizations
    *     description: Retrieve all organizations associated with a specific user
@@ -295,7 +300,7 @@ export class OrgController {
 
   /**
    * @swagger
-   * /api/v1/organisations/{org_id}:
+   * /api/v1/organizations/{org_id}:
    *   get:
    *     summary: Get a single organization
    *     description: Retrieve details of a specific organization by its ID
@@ -401,7 +406,7 @@ export class OrgController {
 
   /**
    * @swagger
-   * /api/v1/organisations/{org_id}/user/{user_id}:
+   * /api/v1/organizations/{org_id}/user/{user_id}:
    *   delete:
    *     summary: Remove a user from an organization
    *     description: Delete a user from a specific organization by user ID and organization ID

src/middleware/index.ts

@@ -1,3 +1,4 @@
 export * from "./error";
 export * from "./auth";
 export * from "./checkUserRole";
+export * from "./organizationValidation";

src/routes/organisation.ts

@@ -1,21 +1,24 @@
 import Router from "express";
 import { OrgController } from "../controllers/OrgController";
-import { authMiddleware, checkPermissions } from "../middleware";
 import { UserRole } from "../enums/userRoles";
-import { organizationValidation } from "../middleware/organization.validation";
-import { validateOrgId } from "../middleware/organization.validation";
+import {
+  authMiddleware,
+  checkPermissions,
+  organizationValidation,
+  validateOrgId,
+} from "../middleware";
 
 const orgRouter = Router();
 const orgController = new OrgController();
 
 orgRouter.get(
-  "/organisations/:org_id",
+  "/organizations/:org_id",
   authMiddleware,
   validateOrgId,
   orgController.getSingleOrg.bind(orgController),
 );
 orgRouter.delete(
-  "/organisations/:org_id/user/:user_id",
+  "/organizations/:org_id/user/:user_id",
   authMiddleware,
   validateOrgId,
   orgController.removeUser.bind(orgController),
@@ -28,7 +31,7 @@ orgRouter.get(
   orgController.generateInviteLink.bind(orgController),
 );
 orgRouter.post(
-  "/organisations",
+  "/organizations",
   authMiddleware,
   organizationValidation,
   orgController.createOrganisation.bind(orgController),
@@ -47,7 +50,7 @@ orgRouter.post(
   orgController.sendInviteLinks.bind(orgController),
 );
 orgRouter.get(
-  "/users/:id/organisations",
+  "/users/:id/organizations",
   authMiddleware,
   orgController.getOrganizations.bind(orgController),
 );

src/routes/product.ts

@@ -2,7 +2,7 @@ import { Router } from "express";
 import { ProductController } from "../controllers/ProductController";
 import { authMiddleware } from "../middleware";
 import { validateProductDetails } from "../middleware/product";
-import { validateUserToOrg } from "../middleware/organization.validation";
+import { validateUserToOrg } from "../middleware/organizationValidation";
 import { adminOnly } from "../middleware";
 
 const productRouter = Router();

src/services/org.services.ts

@@ -12,28 +12,29 @@ import renderTemplate from "../views/email/renderTemplate";
 import { Conflict, ResourceNotFound } from "../middleware/error";
 import config from "../config/index";
 const frontendBaseUrl = config.BASE_URL;
+
 export class OrgService implements IOrgService {
   public async createOrganisation(
     payload: ICreateOrganisation,
     userId: string,
   ): Promise<{
-    newOrganisation: Partial<Organization>;
+    new_organisation: Partial<Organization>;
   }> {
     try {
       const organisation = new Organization();
       organisation.owner_id = userId;
       Object.assign(organisation, payload);
 
-      const newOrganisation = await AppDataSource.manager.save(organisation);
+      const new_organisation = await AppDataSource.manager.save(organisation);
 
       const userOrganization = new UserOrganization();
       userOrganization.userId = userId;
-      userOrganization.organizationId = newOrganisation.id;
+      userOrganization.organizationId = new_organisation.id;
       userOrganization.role = UserRole.ADMIN;
 
       await AppDataSource.manager.save(userOrganization);
 
-      return { newOrganisation };
+      return { new_organisation };
     } catch (error) {
       throw new BadRequest("Client error");
     }
@@ -282,10 +283,6 @@ export class OrgService implements IOrgService {
     userOrganization.role = UserRole.USER;
 
     await userOrganizationRepository.save(userOrganization);
-
-    // if (invitation) {
-    //   await invitationRepository.remove(invitation);
-    // }
   }
 
   public async searchOrganizationMembers(criteria: {

src/test/organisation.spec.ts

@@ -10,7 +10,7 @@ import { AuthService } from "../services/index.ts";
 import { authMiddleware } from "../middleware/auth.ts";
 import { OrgService } from "../services/org.services.ts";
 import { OrgController } from "../controllers/OrgController.ts";
-import { validateOrgId } from "../middleware/organization.validation.ts";
+import { validateOrgId } from "../middleware/organizationValidation.ts";
 import { InvalidInput } from "../middleware/error.ts";
 import { authMiddleware } from "../middleware";
 import { OrgService } from "../services/organisation.service";