🚀 feat: Banner (#3952)

* feat: Add banner schema and model

* feat: Add optional JwtAuth

To handle the conditional logic with and without authentication within the model.

* feat: Add an endpoint to retrieve a banner

* feat: Add implementation for client to use banner and access API

* feat: Display a banner on UI

* feat: Script for updating and deleting banners

* style: Update banner style

* fix: Adjust the height when the banner is displayed

* fix: failed specs

api/models/Banner.js

@@ -0,0 +1,27 @@
+const Banner = require('./schema/banner');
+const logger = require('~/config/winston');
+/**
+ * Retrieves the current active banner.
+ * @returns {Promise<Object|null>} The active banner object or null if no active banner is found.
+ */
+const getBanner = async (user) => {
+  try {
+    const now = new Date();
+    const banner = await Banner.findOne({
+      displayFrom: { $lte: now },
+      $or: [{ displayTo: { $gte: now } }, { displayTo: null }],
+      type: 'banner',
+    }).lean();
+
+    if (!banner || banner.isPublic || user) {
+      return banner;
+    }
+
+    return null;
+  } catch (error) {
+    logger.error('[getBanners] Error getting banners', error);
+    throw new Error('Error getting banners');
+  }
+};
+
+module.exports = { getBanner };

api/models/schema/banner.js

@@ -0,0 +1,36 @@
+const mongoose = require('mongoose');
+
+const bannerSchema = mongoose.Schema(
+  {
+    bannerId: {
+      type: String,
+      required: true,
+    },
+    message: {
+      type: String,
+      required: true,
+    },
+    displayFrom: {
+      type: Date,
+      required: true,
+      default: Date.now,
+    },
+    displayTo: {
+      type: Date,
+    },
+    type: {
+      type: String,
+      enum: ['banner', 'popup'],
+      default: 'banner',
+    },
+    isPublic: {
+      type: Boolean,
+      default: false,
+    },
+  },
+
+  { timestamps: true },
+);
+
+const Banner = mongoose.model('Banner', bannerSchema);
+module.exports = Banner;

api/server/index.js

@@ -106,6 +106,7 @@ const startServer = async () => {
   app.use('/api/share', routes.share);
   app.use('/api/roles', routes.roles);
   app.use('/api/agents', routes.agents);
+  app.use('/api/banner', routes.banner);
   app.use('/api/bedrock', routes.bedrock);
 
   app.use('/api/tags', routes.tags);

api/server/middleware/optionalJwtAuth.js

@@ -0,0 +1,17 @@
+const passport = require('passport');
+
+// This middleware does not require authentication,
+// but if the user is authenticated, it will set the user object.
+const optionalJwtAuth = (req, res, next) => {
+  passport.authenticate('jwt', { session: false }, (err, user) => {
+    if (err) {
+      return next(err);
+    }
+    if (user) {
+      req.user = user;
+    }
+    next();
+  })(req, res, next);
+};
+
+module.exports = optionalJwtAuth;

api/server/routes/banner.js

@@ -0,0 +1,15 @@
+const express = require('express');
+
+const { getBanner } = require('~/models/Banner');
+const optionalJwtAuth = require('~/server/middleware/optionalJwtAuth');
+const router = express.Router();
+
+router.get('/', optionalJwtAuth, async (req, res) => {
+  try {
+    res.status(200).send(await getBanner(req.user));
+  } catch (error) {
+    res.status(500).json({ message: 'Error getting banner' });
+  }
+});
+
+module.exports = router;

api/server/routes/index.js

@@ -24,6 +24,7 @@ const edit = require('./edit');
 const keys = require('./keys');
 const user = require('./user');
 const ask = require('./ask');
+const banner = require('./banner');
 
 module.exports = {
   ask,
@@ -52,4 +53,5 @@ module.exports = {
   assistants,
   categories,
   staticRoute,
+  banner,
 };