LibreChat/packages/data-schemas/src/methods/banner.ts

import type { Model } from 'mongoose';
import logger from '~/config/winston';
import type { IBanner, IUser } from '~/types';

export function createBannerMethods(mongoose: typeof import('mongoose')) {
  /**
   * Retrieves the current active banner.
   */
  async function getBanner(user?: IUser | null): Promise<IBanner | null> {
    try {
      const Banner = mongoose.models.Banner as Model<IBanner>;
      const now = new Date();
      const banner = (await Banner.findOne({
        displayFrom: { $lte: now },
        $or: [{ displayTo: { $gte: now } }, { displayTo: null }],
        type: 'banner',
      }).lean()) as IBanner | null;

      if (!banner || banner.isPublic || user != null) {
        return banner;
      }

      return null;
    } catch (error) {
      logger.error('[getBanners] Error getting banners', error);
      throw new Error('Error getting banners');
    }
  }

  return { getBanner };
}

export type BannerMethods = ReturnType<typeof createBannerMethods>;