Feature: Addition of Venue for Events

schema.graphql

@@ -465,6 +465,14 @@ input DonationWhereInput {
   name_of_user_starts_with: String
 }
 
+input EditVenueInput {
+  capacity: Int
+  description: String
+  file: String
+  id: ID!
+  name: String
+}
+
 enum EducationGrade {
   GRADE_1
   GRADE_2
@@ -913,9 +921,12 @@ type Mutation {
   createSampleOrganization: Boolean!
   createUserFamily(data: createUserFamilyInput!): UserFamily!
   createUserTag(input: CreateUserTagInput!): UserTag
+  createVenue(data: VenueInput!): Venue
   deleteAdvertisement(id: ID!): DeleteAdvertisementPayload
   deleteAgendaCategory(id: ID!): ID!
   deleteDonationById(id: ID!): DeletePayload!
+  deleteVenue(id: ID!): Venue
+  editVenue(data: EditVenueInput!): Venue
   forgotPassword(data: ForgotPasswordData!): Boolean!
   inviteEventAttendee(data: EventAttendeeInput!): EventAttendee!
   joinPublicOrganization(organizationId: ID!): User!
@@ -1013,6 +1024,7 @@ type Organization {
   updatedAt: DateTime!
   userRegistrationRequired: Boolean!
   userTags(after: String, before: String, first: PositiveInt, last: PositiveInt): UserTagsConnection
+  venues: [Venue]
   visibleInSearch: Boolean!
 }
 
@@ -1271,6 +1283,7 @@ type Query {
   userLanguage(userId: ID!): String
   users(adminApproved: Boolean, first: Int, orderBy: UserOrderByInput, skip: Int, userType: String, where: UserWhereInput): [User]
   usersConnection(first: Int, orderBy: UserOrderByInput, skip: Int, where: UserWhereInput): [User]!
+  venue(id: ID!): Venue
 }
 
 input RecaptchaVerification {
@@ -1659,6 +1672,23 @@ type UsersConnectionEdge {
   node: User!
 }
 
+type Venue {
+  _id: ID!
+  capacity: Int!
+  description: String
+  imageUrl: URL
+  name: String!
+  organization: Organization!
+}
+
+input VenueInput {
+  capacity: Int!
+  description: String
+  file: String
+  name: String!
+  organizationId: ID!
+}
+
 enum WeekDays {
   FR
   MO

src/constants.ts

@@ -41,6 +41,21 @@ export const CHAT_NOT_FOUND_ERROR = {
   MESSAGE: "chat.notFound",
   PARAM: "chat",
 };
+
+export const VENUE_ALREADY_EXISTS_ERROR = {
+  DESC: "Venue already exists",
+  CODE: "venue.alreadyExists",
+  MESSAGE: "venue.alreadyExists",
+  PARAM: "venue",
+};
+
+export const VENUE_NOT_FOUND_ERROR = {
+  DESC: "Venue does not exist",
+  CODE: "venue.NotFound",
+  MESSAGE: "venue.NotFound",
+  PARAM: "venue",
+};
+
 export const COMMENT_NOT_FOUND_ERROR = {
   DESC: "Comment not found",
   CODE: "comment.notFound",
@@ -138,6 +153,20 @@ export const ORGANIZATION_NOT_FOUND_ERROR = {
   MESSAGE: "organization.notFound",
   PARAM: "organization",
 };
+export const VENUE_NAME_MISSING_ERROR = {
+  DESC: "Venue name not found",
+  CODE: "venueName.notFound",
+  MESSAGE: "venueName.notFound",
+  PARAM: "venueName",
+};
+
+export const VENUE_ALREADY_SCHEDULED = {
+  DESC: "Venue is already scheduled",
+  CODE: "venue.alreadySchduled",
+  MESSAGE: "venue.alreadySchduled",
+  PARAM: "venue",
+};
+
 export const ORGANIZATION_IMAGE_NOT_FOUND_ERROR = {
   DESC: "OrganizationImage not found",
   CODE: "organizationImage.notFound",

src/models/Venue.ts

@@ -0,0 +1,52 @@
+import { Schema, model, models } from "mongoose";
+import type { Model, Types, PopulatedDoc } from "mongoose";
+import type { InterfaceOrganization } from "./Organization";
+
+export interface InterfaceVenue {
+  _id: Types.ObjectId;
+  name: string;
+  description: string | undefined | null;
+  capacity: number;
+  imageUrl: string | undefined | null;
+  organization: PopulatedDoc<InterfaceOrganization & Document>;
+}
+
+/**
+ * This describes the schema for a Venue that corresponds to InterfaceVenue document.
+ * @param name - Name of the venue.
+ * @param description - Description of the venue.
+ * @param capacity - Maximum capacity of the venue.
+ * @param imageUrl - Image URL(if attached) of the venue.
+ * @param organization - Organization in which the venue belongs.
+ */
+
+const venueSchema = new Schema({
+  name: {
+    type: String,
+    required: true,
+  },
+  description: {
+    type: String,
+  },
+  capacity: {
+    type: Number,
+    required: true,
+  },
+  imageUrl: {
+    type: String,
+    required: false,
+  },
+  organization: {
+    type: Schema.Types.ObjectId,
+    ref: "Organization",
+    required: true,
+  },
+});
+
+const venueModel = (): Model<InterfaceVenue> =>
+  model<InterfaceVenue>("Venue", venueSchema);
+
+// This syntax is needed to prevent Mongoose OverwriteModelError while running tests.
+export const Venue = (models.Venue || venueModel()) as ReturnType<
+  typeof venueModel
+>;

src/models/index.ts

@@ -30,4 +30,5 @@ export * from "./PluginField";
 export * from "./Post";
 export * from "./SampleData";
 export * from "./TagUser";
+export * from "./Venue";
 export * from "./User";

src/resolvers/Mutation/createVenue.ts

@@ -0,0 +1,116 @@
+import { Organization, User } from "../../models";
+import type { MutationResolvers } from "../../types/generatedGraphQLTypes";
+import {
+  ORGANIZATION_NOT_FOUND_ERROR,
+  VENUE_ALREADY_EXISTS_ERROR,
+  USER_NOT_FOUND_ERROR,
+  VENUE_NAME_MISSING_ERROR,
+  ORGANIZATION_NOT_AUTHORIZED_ERROR,
+} from "../../constants";
+import { errors, requestContext } from "../../libraries";
+import { Venue } from "../../models/Venue";
+import { uploadEncodedImage } from "../../utilities/encodedImageStorage/uploadEncodedImage";
+/**
+ * This function enables to create a venue in an organization.
+ * @param _parent - parent of current request
+ * @param args - payload provided with the request
+ * @param context - context of entire application
+ * @remarks The following checks are done:
+ * 1. If the user exists
+ * 2. If the organization exists
+ * 3. Whether the user is admin or superadmin or not
+ * 4. If the venue name is missing
+ * 5. If the same venue already exists in an organization
+ * @returns Created venue
+ */
+
+export const createVenue: MutationResolvers["createVenue"] = async (
+  _parent,
+  args,
+  context,
+) => {
+  const currentUser = await User.findOne({
+    _id: context.userId,
+  });
+
+  // Checks whether currentUser with _id == context.userId exists.
+  if (currentUser === null) {
+    throw new errors.NotFoundError(
+      requestContext.translate(USER_NOT_FOUND_ERROR.MESSAGE),
+      USER_NOT_FOUND_ERROR.CODE,
+      USER_NOT_FOUND_ERROR.PARAM,
+    );
+  }
+
+  const organization = await Organization.findOne({
+    _id: args.data.organizationId,
+  });
+
+  // Checks whether organization exists.
+  if (!organization) {
+    throw new errors.NotFoundError(
+      requestContext.translate(ORGANIZATION_NOT_FOUND_ERROR.MESSAGE),
+      ORGANIZATION_NOT_FOUND_ERROR.CODE,
+      ORGANIZATION_NOT_FOUND_ERROR.PARAM,
+    );
+  }
+
+  // Checks Whether the user is admin or superadmin or not
+  if (
+    !(
+      organization.admins?.some((admin) => admin._id.equals(context.userId)) ||
+      currentUser.userType == "SUPERADMIN"
+    )
+  ) {
+    throw new errors.UnauthorizedError(
+      requestContext.translate(ORGANIZATION_NOT_AUTHORIZED_ERROR.MESSAGE),
+      ORGANIZATION_NOT_AUTHORIZED_ERROR.CODE,
+      ORGANIZATION_NOT_AUTHORIZED_ERROR.PARAM,
+    );
+  }
+
+  // Check if the venue name provided is empty string
+  if (!args.data?.name ?? "") {
+    throw new errors.InputValidationError(
+      requestContext.translate(VENUE_NAME_MISSING_ERROR.MESSAGE),
+      VENUE_NAME_MISSING_ERROR.CODE,
+      VENUE_NAME_MISSING_ERROR.PARAM,
+    );
+  }
+
+  // Check if a venue with the same organizationId and name exists
+  const existingVenue = await Venue.findOne({
+    name: args.data.name,
+    organization: args.data.organizationId,
+  });
+
+  if (existingVenue) {
+    throw new errors.ConflictError(
+      requestContext.translate(VENUE_ALREADY_EXISTS_ERROR.MESSAGE),
+      VENUE_ALREADY_EXISTS_ERROR.CODE,
+      VENUE_ALREADY_EXISTS_ERROR.PARAM,
+    );
+  }
+
+  let uploadImageFileName = null;
+
+  if (args.data?.file) {
+    const dataUrlPrefix = "data:";
+    if (args.data.file.startsWith(dataUrlPrefix + "image/")) {
+      uploadImageFileName = await uploadEncodedImage(args.data.file, null);
+    }
+  }
+
+  const newVenue = await Venue.create({
+    ...args.data,
+    organization: organization._id,
+    imageUrl: uploadImageFileName
+      ? `${context.apiRootUrl}${uploadImageFileName}`
+      : null,
+  });
+
+  return {
+    ...newVenue.toObject(),
+    organization: organization.toObject(),
+  };
+};

src/resolvers/Mutation/deleteVenue.ts

@@ -0,0 +1,87 @@
+import { Organization, User } from "../../models";
+import type { MutationResolvers } from "../../types/generatedGraphQLTypes";
+import {
+  ORGANIZATION_NOT_FOUND_ERROR,
+  USER_NOT_FOUND_ERROR,
+  ORGANIZATION_NOT_AUTHORIZED_ERROR,
+  VENUE_NOT_FOUND_ERROR,
+} from "../../constants";
+import { errors, requestContext } from "../../libraries";
+import { Venue } from "../../models/Venue";
+/**
+ * This function enables to create a venue in an organization.
+ * @param _parent - parent of current request
+ * @param args - payload provided with the request
+ * @param context - context of entire application
+ * @remarks The following checks are done:
+ * 1. If the user exists
+ * 2. If the organization exists
+ * 3. Whether the user is admin or superadmin or not
+ * 4. If the venue exists
+ * @returns Deleted venue
+ */
+
+export const deleteVenue: MutationResolvers["deleteVenue"] = async (
+  _parent,
+  args,
+  context,
+) => {
+  const currentUser = await User.findOne({
+    _id: context.userId,
+  });
+
+  // Checks whether currentUser with _id == context.userId exists.
+  if (currentUser === null) {
+    throw new errors.NotFoundError(
+      requestContext.translate(USER_NOT_FOUND_ERROR.MESSAGE),
+      USER_NOT_FOUND_ERROR.CODE,
+      USER_NOT_FOUND_ERROR.PARAM,
+    );
+  }
+
+  const venue = await Venue.findOne({
+    _id: args.id,
+  });
+
+  if (!venue) {
+    throw new errors.NotFoundError(
+      requestContext.translate(VENUE_NOT_FOUND_ERROR.MESSAGE),
+      VENUE_NOT_FOUND_ERROR.CODE,
+      VENUE_NOT_FOUND_ERROR.PARAM,
+    );
+  }
+
+  const organization = await Organization.findById({
+    _id: venue.organization,
+  });
+
+  // Checks whether organization exists.
+  if (!organization) {
+    throw new errors.NotFoundError(
+      requestContext.translate(ORGANIZATION_NOT_FOUND_ERROR.MESSAGE),
+      ORGANIZATION_NOT_FOUND_ERROR.CODE,
+      ORGANIZATION_NOT_FOUND_ERROR.PARAM,
+    );
+  }
+
+  // Checks Whether the user is admin or superadmin or not
+  if (
+    !(
+      organization.admins?.some((admin) => admin._id.equals(context.userId)) ||
+      currentUser.userType == "SUPERADMIN"
+    )
+  ) {
+    throw new errors.UnauthorizedError(
+      requestContext.translate(ORGANIZATION_NOT_AUTHORIZED_ERROR.MESSAGE),
+      ORGANIZATION_NOT_AUTHORIZED_ERROR.CODE,
+      ORGANIZATION_NOT_AUTHORIZED_ERROR.PARAM,
+    );
+  }
+
+  await Venue.findByIdAndDelete(venue._id);
+
+  return {
+    ...venue.toObject(),
+    organization: organization.toObject(),
+  };
+};