Merge pull request #45 from StreetSupport/feature/3017-create-location-specific-content-management-system

3017 - implement banners

Author: o-seliuchenko

src/controllers/bannerController.ts

@@ -1,6 +1,6 @@
 import { Request, Response } from 'express';
 import { asyncHandler } from '../utils/asyncHandler.js';
-import { BannerTemplateType } from '../types/index.js';
+import { BackgroundType, BannerTemplateType } from '../types/index.js';
 import { validateBanner } from '../schemas/bannerSchema.js';
 import Banner from '../models/bannerModel.js';
 import { deleteFile } from '../middleware/uploadMiddleware.js';
@@ -139,7 +139,10 @@ export const createBanner = asyncHandler(async (req: Request, res: Response) =>
   }
 
   // Handle resource project specific logic
-  const finalBannerData = _handleResourceProjectBannerLogic({ ...validation.data });
+  let finalBannerData = _handleResourceProjectBannerLogic({ ...validation.data });
+  
+  // Handle background image specific logic
+  finalBannerData = handleBackgroundImageLogic(finalBannerData);
 
   // Add creator information and system fields
   const bannerData = {
@@ -181,8 +184,17 @@ export const updateBanner = asyncHandler(async (req: Request, res: Response) =>
   // Store old banner data for file cleanup
   const oldBannerData = banner.toObject();
 
+  // Handle template type change from RESOURCE_PROJECT to another type
+  if (oldBannerData.TemplateType === BannerTemplateType.RESOURCE_PROJECT && 
+      validation?.data?.TemplateType !== BannerTemplateType.RESOURCE_PROJECT) {
+    await handleResourceProjectTemplateChange(oldBannerData, validation.data);
+  }
+
   // Handle resource project specific logic
-  const finalBannerData = _handleResourceProjectBannerLogic({ ...validation.data });
+  let finalBannerData = _handleResourceProjectBannerLogic({ ...validation.data });
+  
+  // Handle background image specific logic
+  finalBannerData = handleBackgroundImageLogic(finalBannerData);
 
   // Preserve existing activation date fields and IsActive (not editable in edit form)
   finalBannerData.StartDate = banner.StartDate;
@@ -331,20 +343,63 @@ function _handleResourceProjectBannerLogic(bannerData: any): any {
     if (resourceFile.Url && !resourceFile.FileUrl) {
       bannerData.ResourceProject.ResourceFile.FileUrl = resourceFile.Url;
     }
-    // Add foreach to populate Url depending on AutomaticallyPopulatedUrl
+
     // Update the 'Download' CTA button URL to use the file URL
     const fileUrl = bannerData.ResourceProject.ResourceFile.FileUrl;
     if (bannerData.CtaButtons && bannerData.CtaButtons.length > 0 && fileUrl) {
       const downloadButtonIndex = 0;
       const button = bannerData.CtaButtons[downloadButtonIndex];
-      if (button && button.AutomaticallyPopulatedUrl) {
+      if (button) {
         button.Url = fileUrl;
       }
     }
   }
   return bannerData;
 }
 
+// Private helper to handle template type change from RESOURCE_PROJECT
+// Cleans up resource file and CTA button with blob URL when template type changes
+async function handleResourceProjectTemplateChange(oldBannerData: any, newBannerData: any): Promise<void> {
+  // Check if old banner had a resource file with a blob URL
+  if (oldBannerData.ResourceProject?.ResourceFile?.FileUrl) {
+    const fileUrl = oldBannerData.ResourceProject.ResourceFile.FileUrl;
+    
+    // Delete the resource file from blob storage if it's a blob URL
+    if (fileUrl.includes('blob.core.windows.net')) {
+      try {
+        await deleteFile(fileUrl);
+        console.log(`Cleaned up resource file during template type change: ${fileUrl}`);
+      } catch (error) {
+        console.error(`Failed to delete resource file ${fileUrl} during template type change:`, error);
+        // Don't throw error - file cleanup failure shouldn't break the update
+      }
+    }
+  }
+}
+
+// Private helper to handle background image logic
+// Automatically populates Background.Value with BackgroundImage URL when Background.Type is 'image'
+function handleBackgroundImageLogic(bannerData: any): any {
+  // Ensure Background object exists
+  if (!bannerData.Background) {
+    return bannerData;
+  }
+
+  // If Background.Type is 'image', handle the BackgroundImage URL
+  if (bannerData.Background.Type === BackgroundType.IMAGE) {
+    // Case 1: BackgroundImage exists - populate Background.Value with its URL
+    if (bannerData.BackgroundImage && bannerData.BackgroundImage.Url) {
+      bannerData.Background.Value = bannerData.BackgroundImage.Url;
+    } 
+    // Case 2: BackgroundImage was removed - clear Background.Value
+    else {
+      bannerData.Background.Value = '';
+    }
+  }
+
+  return bannerData;
+}
+
 // Helper function to extract all file URLs from a banner
 function extractFileUrls(banner: any): string[] {
   const urls: string[] = [];
@@ -353,8 +408,6 @@ function extractFileUrls(banner: any): string[] {
   if (banner.Logo?.Url) urls.push(banner.Logo.Url);
   if (banner.BackgroundImage?.Url) urls.push(banner.BackgroundImage.Url);
   if (banner.MainImage?.Url) urls.push(banner.MainImage.Url);
-  // TODO: Uncomment if AccentGraphic is needed. In the other case, remove.
-  // if (banner.AccentGraphic?.Url) urls.push(banner.AccentGraphic.Url);
 
   // Partner logos for partnership charter banners (nested structure)
   if (banner.PartnershipCharter?.PartnerLogos && Array.isArray(banner.PartnershipCharter.PartnerLogos)) {
@@ -377,8 +430,6 @@ function processMediaFields(req: Request): any {
   // Note: I still not sure if it makes sense to use this merging instead of req.body
   const processedData = { ...req.body, ...req.preValidatedData };
 
-  // TODO: Uncomment if AccentGraphic is needed. In the other case, remove.
-  // Process single media assets: Logo, BackgroundImage, MainImage, AccentGraphic
   ['Logo', 'BackgroundImage', 'MainImage' /*, 'AccentGraphic'*/].forEach(field => {
     const newFileData = processedData[`newfile_${field}`];
     const newMetadata = processedData[`newmetadata_${field}`] 

src/middleware/uploadMiddleware.ts

@@ -158,8 +158,7 @@ async function processUploads(req: Request, res: Response, next: NextFunction) {
             }
 
             // Store in appropriate field
-            // TODO: Uncomment if AccentGraphic is needed. In the other case, remove.
-            if (fieldName === 'newfile_Logo' || fieldName === 'newfile_BackgroundImage' || fieldName === 'newfile_MainImage' /* || fieldName === 'newfile_AccentGraphic' */) {
+            if (fieldName === 'newfile_Logo' || fieldName === 'newfile_BackgroundImage' || fieldName === 'newfile_MainImage') {
               uploadedAssets[fieldName] = asset;
             } else if (fieldName === 'newfile_PartnerLogos') {
               if (!uploadedAssets[fieldName]) {
@@ -208,11 +207,8 @@ const handleMultipartData = upload.fields([
   { name: 'newfile_Logo', maxCount: 1 },
   { name: 'newfile_BackgroundImage', maxCount: 1 },
   { name: 'newfile_MainImage', maxCount: 1 },
-  // TODO: Uncomment if AccentGraphic is needed. In the other case, remove.
-  // { name: 'newfile_AccentGraphic', maxCount: 1 },
   { name: 'newfile_PartnerLogos', maxCount: 5 },
   { name: 'newfile_ResourceFile', maxCount: 1 }
-  // SWEP banner image uses uploadSwepImage middleware
 ]);
 
 // Middleware for Banners

src/models/bannerModel.ts

@@ -1,12 +1,10 @@
-// TODO: Uncomment if AccentGraphic is needed. In the other case, remove.
 import { 
   BannerTemplateType, 
   CharterType, 
   IBanner, 
   LayoutStyle, 
   TextColour, 
   UrgencyLevel,
-  // AccentGraphicSchema,
   BannerBackgroundSchema,
   CTAButtonSchema,
   DonationGoalSchema,
@@ -17,7 +15,7 @@ import mongoose, { Schema } from 'mongoose';
 
 // Template-specific nested schemas
 const GivingCampaignSchema = new Schema({
-  UrgencyLevel: { type: String, enum: Object.values(UrgencyLevel) },
+  UrgencyLevel: { type: String, enum: Object.values(UrgencyLevel), required: true },
   CampaignEndDate: { type: Date },
   DonationGoal: DonationGoalSchema
 }, { _id: false });
@@ -34,11 +32,6 @@ const ResourceProjectSchema = new Schema({
 
 // Main Banner Schema
 export const BannerSchema = new Schema({
-  // We should check if we need it
-  // _id: {
-  //   type: mongoose.Schema.Types.ObjectId,
-  //   required: true,
-  // },
   DocumentCreationDate: {
     type: Date,
     default: Date.now,
@@ -53,9 +46,9 @@ export const BannerSchema = new Schema({
   },
 
   // Core content
-  Title: { type: String, required: true, maxlength: 200 },
-  Description: { type: String, maxlength: 1000 },
-  Subtitle: { type: String, maxlength: 300 },
+  Title: { type: String, required: true, maxlength: 50 },
+  Description: { type: String, maxlength: 200 },
+  Subtitle: { type: String, maxlength: 50 },
 
   // Template type
   TemplateType: { 
@@ -68,8 +61,6 @@ export const BannerSchema = new Schema({
   Logo: MediaAssetSchema,
   BackgroundImage: MediaAssetSchema,
   MainImage: MediaAssetSchema, // Separate image for split layout (not background)
-  // TODO: Uncomment if AccentGraphic is needed. In the other case, remove.
-  // AccentGraphic: AccentGraphicSchema,
 
   // Actions
   CtaButtons: {
@@ -102,6 +93,7 @@ export const BannerSchema = new Schema({
   // CMS metadata
   IsActive: { type: Boolean, default: true },
   LocationSlug: { type: String, required: true },
+  LocationName: { type: String, required: true },
   Priority: { type: Number, min: 1, max: 10, default: 5 },
 
   // Analytics

src/schemas/bannerSchema.ts

@@ -1,8 +1,6 @@
 import { z } from 'zod';
 import {
   MediaAssetSchemaCore,
-  // TODO: Uncomment if AccentGraphic is needed. In the other case, remove.
-  // AccentGraphicSchemaCore,
   BannerBackgroundSchemaCore,
   CTAButtonSchemaCore,
   DonationGoalSchemaCore,
@@ -27,8 +25,6 @@ import { BannerTemplateType, UrgencyLevel, CharterType, LayoutStyle, TextColour,
 
 // API-specific schemas with preprocessing for FormData
 export const MediaAssetSchema = MediaAssetSchemaCore;
-// TODO: Uncomment if AccentGraphic is needed. In the other case, remove.
-// export const AccentGraphicSchema = AccentGraphicSchemaCore;
 export const BannerBackgroundSchema = BannerBackgroundSchemaCore;
 export const CTAButtonSchema = CTAButtonSchemaCore;
 
@@ -43,7 +39,7 @@ export const ResourceFileSchema = z.preprocess(preprocessJSON, ResourceFileSchem
 
 // API-specific schema for ResourceFile to handle nested date preprocessing
 export const ResourceFileApiSchema = ResourceFileSchemaCore.extend({
-  LastUpdated: z.preprocess(preprocessDate, z.date()).optional(),
+  LastUpdated: z.preprocess(preprocessDate, z.date()),
 }).optional();
 
 // API-specific schema for ResourceProject to use ResourceFileApiSchema
@@ -117,7 +113,7 @@ export const BannerPreUploadApiSchema = z.object({
   // Styling (excluding file-based background)
   Background: z.preprocess(preprocessJSON, z.object({
     Type: z.nativeEnum(BackgroundType),
-    Value: z.string().optional(),
+    Value: z.string().min(1, 'Background value is required'),
     Overlay: z.object({
       Colour: z.string().optional(),
       Opacity: z.preprocess(preprocessNumber, z.number().min(0).max(1)).optional()