Adding Advertisement feature in API (PalisadoesFoundation#1395)

* Add: Advert model

* Add: Advert model

* Add: graphql types

* Add: createAd, removeAd, getAllAds

* 2

* 2

* Ad: 3

* Added: Typedefs

* Test: removeadvertisement

* test: get advertisement

* fix

* fix: errors

* updated add types

.env.sample

@@ -91,3 +91,4 @@ LOG_LEVEL = info
 
 REDIS_HOST=
 REDIS_PORT=
+REDIS_PASSWORD=

locales/en.json

@@ -5,6 +5,7 @@
   "user.alreadyMember": "User is already a member",
   "user.profileImage.notFound": "User profile image not found",
   "task.notFound": "Task not found",
+  "advertisement.notFound": "Advertisement not found",
   "event.notFound": "Event not found",
   "eventProject.notFound": "Event project not found",
   "organization.notFound": "Organization not found",

locales/hi.json

@@ -5,6 +5,7 @@
   "user.alreadyMember": "उपयोगकर्ता पहले से ही एक सदस्य है",
   "user.profileImage.notFound": "उपयोगकर्ता प्रोफ़ाइल छवि नहीं मिली",
   "task.notFound": "कार्य नहीं मिला",
+  "advertisement.notFound": "विज्ञापन नहीं मिला",
   "event.notFound": "घटना नहीं मिली",
   "eventProject.notFound": "इवेंट प्रोजेक्ट नहीं मिला",
   "organization.notFound": "संगठन नहीं मिला",

schema.graphql

@@ -2,6 +2,16 @@ directive @auth on FIELD_DEFINITION
 
 directive @role(requires: UserType) on FIELD_DEFINITION
 
+type Advertisement {
+  _id: ID
+  endDate: Date!
+  link: String!
+  name: String!
+  orgId: ID
+  startDate: Date!
+  type: String!
+}
+
 type AggregatePost {
   count: Int!
 }
@@ -422,6 +432,7 @@ type Mutation {
   cancelMembershipRequest(membershipRequestId: ID!): MembershipRequest!
   checkIn(data: CheckInInput!): CheckIn!
   createAdmin(data: UserAndOrganizationInput!): User!
+  createAdvertisement(endDate: Date!, link: String!, name: String!, orgId: ID!, startDate: Date!, type: String!): Advertisement!
   createComment(data: CommentInput!, postId: ID!): Comment
   createDirectChat(data: createChatInput!): DirectChat!
   createDonation(amount: Float!, nameOfOrg: String!, nameOfUser: String!, orgId: ID!, payPalId: ID!, userId: ID!): Donation!
@@ -450,6 +461,7 @@ type Mutation {
   rejectAdmin(id: ID!): Boolean!
   rejectMembershipRequest(membershipRequestId: ID!): MembershipRequest!
   removeAdmin(data: UserAndOrganizationInput!): User!
+  removeAdvertisement(id: ID!): Advertisement
   removeComment(id: ID!): Comment
   removeDirectChat(chatId: ID!, organizationId: ID!): DirectChat!
   removeEvent(id: ID!): Event!
@@ -722,6 +734,7 @@ type Query {
   event(id: ID!): Event
   eventsByOrganization(id: ID, orderBy: EventOrderByInput): [Event]
   eventsByOrganizationConnection(first: Int, orderBy: EventOrderByInput, skip: Int, where: EventWhereInput): [Event!]!
+  getAdvertisements: [Advertisement]
   getDonationById(id: ID!): Donation!
   getDonationByOrgId(orgId: ID!): [Donation]
   getDonationByOrgIdConnection(first: Int, orgId: ID!, skip: Int, where: DonationWhereInput): [Donation!]!

src/constants.ts

@@ -265,7 +265,12 @@ export const TASK_NOT_FOUND_ERROR = {
   MESSAGE: "task.notFound",
   PARAM: "task",
 };
-
+export const ADVERTISEMENT_NOT_FOUND_ERROR = {
+  DESC: "Advertisement not found",
+  CODE: "advertisement.notFound",
+  MESSAGE: "advertisement.notFound",
+  PARAM: "advertisement",
+};
 export const STATUS_ACTIVE = "ACTIVE";
 
 export const URL =

src/models/Advertisement.ts

@@ -0,0 +1,81 @@
+import type { Types, Model } from "mongoose";
+import { Schema, model, models } from "mongoose";
+/**
+ * This is an interface that represents a database(MongoDB) document for Advertisement.
+ */
+type AdvertisementTypes = {
+  type: "POPUP" | "MENU" | "BANNER";
+  // Other properties specific to each type
+};
+export interface InterfaceAdvertisement {
+  _id: Types.ObjectId;
+  orgId: string;
+  name: string;
+  link: string;
+  type: AdvertisementTypes;
+  startDate: string;
+  endDate: string;
+}
+
+/**
+ * @param  name - Name of the advertisement (type: String)
+ * Description: Name of the advertisement.
+ */
+
+/**
+ * @param  orgId - Organization ID associated with the advertisement (type: Schema.Types.ObjectId)
+ * Description: Organization ID associated with the advertisement.
+ */
+
+/**
+ * @param  link - Link associated with the advertisement (type: String)
+ * Description: Link associated with the advertisement.
+ */
+
+/**
+ * @param  type - Type of advertisement (POPUP, MENU, BANNER) (type: String)
+ * Description: Type of advertisement (POPUP, MENU, BANNER).
+ */
+
+/**
+ * @param  startDate - Start date of the advertisement (type: Date)
+ * Description: Start date of the advertisement.
+ */
+
+/**
+ * @param  endDate - End date of the advertisement (type: Date)
+ * Description: End date of the advertisement.
+ */
+const advertisementSchema = new Schema({
+  name: {
+    type: String,
+    required: true,
+  },
+  orgId: {
+    type: String,
+  },
+  link: {
+    type: String,
+    required: true,
+  },
+  type: {
+    type: String,
+    enum: ["POPUP", "MENU", "BANNER"],
+    required: true,
+  },
+  startDate: {
+    type: String,
+    required: true,
+  },
+  endDate: {
+    type: String,
+    required: true,
+  },
+});
+
+const advertisementModel = (): Model<InterfaceAdvertisement> =>
+  model<InterfaceAdvertisement>("Advertisement", advertisementSchema);
+
+// This syntax is needed to prevent Mongoose OverwriteModelError while running tests.
+export const Advertisement = (models.Advertisement ||
+  advertisementModel()) as ReturnType<typeof advertisementModel>;

src/models/index.ts

@@ -1,3 +1,4 @@
+export * from "./Advertisement";
 export * from "./CheckIn";
 export * from "./MessageChat";
 export * from "./Comment";

src/resolvers/Mutation/createAdvertisement.ts

@@ -0,0 +1,18 @@
+import type { MutationResolvers } from "../../types/generatedGraphQLTypes";
+import { Advertisement } from "../../models";
+//eslint-disable-next-line @typescript-eslint/naming-convention
+const { ObjectId } = require("mongodb");
+// @ts-ignore
+export const createAdvertisement: MutationResolvers["createAdvertisement"] =
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  async (_parent, args, _context) => {
+    // Creates new Ad.
+    args.orgId = ObjectId(args.orgId);
+    args.startDate = new Date(args.startDate);
+    args.endDate = new Date(args.endDate);
+    const createdAd = await Advertisement.create({
+      ...args,
+    });
+    // Returns createdAd.
+    return createdAd.toObject();
+  };

src/resolvers/Mutation/index.ts

@@ -25,6 +25,7 @@ import { createGroupChat } from "./createGroupChat";
 import { createMessageChat } from "./createMessageChat";
 import { createOrganization } from "./createOrganization";
 import { createPlugin } from "./createPlugin";
+import { createAdvertisement } from "./createAdvertisement";
 import { createPost } from "./createPost";
 import { createTask } from "./createTask";
 import { createUserTag } from "./createUserTag";
@@ -49,6 +50,7 @@ import { removeEvent } from "./removeEvent";
 import { removeEventAttendee } from "./removeEventAttendee";
 import { removeEventProject } from "./removeEventProject";
 import { removeGroupChat } from "./removeGroupChat";
+import { removeAdvertisement } from "./removeAdvertisement";
 import { removeMember } from "./removeMember";
 import { removeOrganization } from "./removeOrganization";
 import { removeOrganizationImage } from "./removeOrganizationImage";
@@ -101,6 +103,7 @@ export const Mutation: MutationResolvers = {
   createMember,
   createAdmin,
   createComment,
+  createAdvertisement,
   createDirectChat,
   createDonation,
   createEvent,
@@ -131,6 +134,7 @@ export const Mutation: MutationResolvers = {
   removeDirectChat,
   removeEvent,
   removeEventAttendee,
+  removeAdvertisement,
   removeEventProject,
   removeGroupChat,
   removeMember,

src/resolvers/Mutation/removeAdvertisement.ts

@@ -0,0 +1,28 @@
+import type { MutationResolvers } from "../../types/generatedGraphQLTypes";
+import { errors, requestContext } from "../../libraries";
+import { Advertisement } from "../../models";
+import { ADVERTISEMENT_NOT_FOUND_ERROR } from "../../constants";
+
+// @ts-ignore
+export const removeAdvertisement: MutationResolvers["removeAdvertisement"] =
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  async (_parent, args, _context) => {
+    const currentAd = await Advertisement.findOne({
+      _id: args.id ? args.id : "",
+    }).lean();
+
+    if (!currentAd) {
+      throw new errors.NotFoundError(
+        requestContext.translate(ADVERTISEMENT_NOT_FOUND_ERROR.MESSAGE),
+        ADVERTISEMENT_NOT_FOUND_ERROR.CODE,
+        ADVERTISEMENT_NOT_FOUND_ERROR.PARAM
+      );
+    }
+
+    // Deletes the ad.
+    await Advertisement.deleteOne({
+      _id: args.id ? args.id : "",
+    });
+    // Returns deleted ad.
+    return currentAd;
+  };

src/resolvers/Query/getAdvertisements.ts

@@ -0,0 +1,11 @@
+import type { QueryResolvers } from "../../types/generatedGraphQLTypes";
+import { Advertisement } from "../../models";
+
+/**
+ * This function returns list of Advertisement from the database.
+ * @returns An object that contains a list of Ads.
+ */
+export const getAdvertisements: QueryResolvers["getAdvertisements"] =
+  async () => {
+    return await Advertisement.find().lean();
+  };

src/resolvers/Query/index.ts

@@ -22,6 +22,7 @@ import { registeredEventsByUser } from "./registeredEventsByUser";
 import { user } from "./user";
 import { userLanguage } from "./userLanguage";
 import { users } from "./users";
+import { getAdvertisements } from "./getAdvertisements";
 import { usersConnection } from "./usersConnection";
 
 export const Query: QueryResolvers = {
@@ -32,6 +33,7 @@ export const Query: QueryResolvers = {
   eventsByOrganization,
   eventsByOrganizationConnection,
   getDonationById,
+  getAdvertisements,
   getDonationByOrgId,
   getDonationByOrgIdConnection,
   getlanguage,

src/services/CommentCache/findCommentsByPostIdInCache.ts

@@ -19,7 +19,7 @@ export async function findCommentsByPostIdInCache(
 
   const commentsFoundInCache = await CommentCache.mget(commentIDs);
 
-  const comments = commentsFoundInCache.map((comment) => {
+  const comments = commentsFoundInCache.map((comment: string | null) => {
     if (comment === null) {
       return null;
     }

src/services/OrganizationCache/findOrganizationsInCache.ts

@@ -12,7 +12,7 @@ export async function findOrganizationsInCache(
 
   const organizationFoundInCache = await OrganizationCache.mget(keys);
 
-  const organizations = organizationFoundInCache.map((org) => {
+  const organizations = organizationFoundInCache.map((org: string | null) => {
     if (org === null) {
       return null;
     }

src/typeDefs/mutations.ts

@@ -76,6 +76,15 @@ export const mutations = gql`
       uninstalledOrgs: [ID!]
     ): Plugin!
 
+    createAdvertisement(
+      orgId: ID!
+      name: String!
+      link: String!
+      type: String!
+      startDate: Date!
+      endDate: Date!
+    ): Advertisement!
+
     createPost(data: PostInput!, file: String): Post @auth
 
     createUserTag(input: CreateUserTagInput!): UserTag @auth
@@ -134,6 +143,8 @@ export const mutations = gql`
 
     removePost(id: ID!): Post @auth
 
+    removeAdvertisement(id: ID!): Advertisement
+
     removeUserTag(id: ID!): UserTag @auth
 
     removeTask(id: ID!): Task @auth

src/typeDefs/queries.ts

@@ -38,6 +38,7 @@ export const queries = gql`
     getlanguage(lang_code: String!): [Translation]
 
     getPlugins: [Plugin]
+    getAdvertisements: [Advertisement]
 
     hasSubmittedFeedback(userId: ID!, eventId: ID!): Boolean
 

src/typeDefs/types.ts

@@ -92,6 +92,15 @@ export const types = gql`
     nameOfOrg: String!
     amount: Float!
   }
+  type Advertisement {
+    _id: ID
+    name: String!
+    orgId: ID
+    link: String!
+    type: String!
+    startDate: Date!
+    endDate: Date!
+  }
 
   type ExtendSession {
     accessToken: String!