Merge pull request #79 from StreetSupport/feature/client-groups-endpoint

Add client groups endpoint and service denormalisation

Author: james-cross

src/app.ts

@@ -10,6 +10,7 @@ import bannerRoutes from './routes/bannerRoutes.js';
 import swepBannerRoutes from './routes/swepBannerRoutes.js';
 import resourceRoutes from './routes/resourceRoutes.js';
 import locationLogoRoutes from './routes/locationLogoRoutes.js';
+import clientGroupRoutes from './routes/clientGroupRoutes.js';
 import { errorHandler, notFound } from './middleware/errorMiddleware.js';
 import checkJwt from './middleware/checkJwt.js';
 import './instrument.js';
@@ -34,6 +35,7 @@ app.use('/api/banners', bannerRoutes);
 app.use('/api/swep-banners', swepBannerRoutes);
 app.use('/api/resources', resourceRoutes);
 app.use('/api/location-logos', locationLogoRoutes);
+app.use('/api/client-groups', clientGroupRoutes);
 
 // The error handler must be registered before any other error middleware and after all controllers
 Sentry.setupExpressErrorHandler(app);

src/controllers/clientGroupController.ts

@@ -0,0 +1,26 @@
+import { Request, Response } from 'express';
+import { asyncHandler } from '../utils/asyncHandler.js';
+import { sendSuccess, sendNotFound, sendInternalError } from '../utils/apiResponses.js';
+import ClientGroup from '../models/clientGroupModel.js';
+
+/**
+ * @desc    Get all client groups
+ * @route   GET /api/client-groups
+ * @access  Private
+ */
+export const getClientGroups = asyncHandler(async (req: Request, res: Response) => {
+  try {
+    const clientGroups = await ClientGroup.find({})
+      .sort({ SortPosition: -1 })
+      .lean();
+
+    if (!clientGroups || clientGroups.length === 0) {
+      return sendNotFound(res, 'No client groups found');
+    }
+
+    return sendSuccess(res, clientGroups);
+  } catch (error) {
+    console.error('Error fetching client groups:', error);
+    return sendInternalError(res, 'Failed to fetch client groups');
+  }
+});

src/controllers/serviceController.ts

@@ -4,9 +4,30 @@ import { asyncHandler } from '../utils/asyncHandler.js';
 import { sendSuccess, sendCreated, sendNotFound, sendBadRequest } from '../utils/apiResponses.js';
 import GroupedService from '../models/groupedServiceModel.js';
 import Service from '../models/serviceModel.js';
+import ClientGroup from '../models/clientGroupModel.js';
 import { processAddressesWithCoordinates, updateLocationIfPostcodeChanged } from '../utils/postcodeValidation.js';
 import { validateGroupedService } from '../schemas/groupedServiceSchema.js';
-import { IGroupedService } from '../types/index.js';
+import { IGroupedService, IClientGroupRef } from '../types/index.js';
+
+/**
+ * Helper function to denormalise client groups from keys
+ * Looks up client group documents and returns denormalised data
+ */
+async function denormaliseClientGroups(clientGroupKeys?: string[]): Promise<IClientGroupRef[]> {
+  if (!clientGroupKeys || clientGroupKeys.length === 0) {
+    return [];
+  }
+
+  const clientGroups = await ClientGroup.find({
+    Key: { $in: clientGroupKeys }
+  }).lean();
+
+  return clientGroups.map(cg => ({
+    Key: cg.Key,
+    Name: cg.Name,
+    SortPosition: cg.SortPosition
+  }));
+}
 
 // @desc    Get all services
 // @route   GET /api/services
@@ -152,8 +173,16 @@ export const createService = asyncHandler(async (req: Request, res: Response) =>
       await processAddressesWithCoordinates([serviceData.Location]);
     }
 
+    // Denormalise client groups if keys provided
+    const clientGroups = serviceData.ClientGroupKeys && serviceData.ClientGroupKeys.length > 0
+      ? await denormaliseClientGroups(serviceData.ClientGroupKeys)
+      : [];
+
     // Create the grouped service
-    const groupedService = await GroupedService.create([serviceData], { session });
+    const groupedService = await GroupedService.create([{
+      ...serviceData,
+      ClientGroups: clientGroups
+    }], { session });
 
     // Create individual ProvidedServices for each subcategory
     await createIndividualServices(groupedService[0], session);
@@ -207,12 +236,12 @@ export const updateService = asyncHandler(async (req: Request, res: Response) =>
     // Check if location postcode has changed and update coordinates accordingly
     if (updateData.Location && updateData.Location.Postcode) {
       const oldLocation = existingService.Location;
-      
+
       if (oldLocation && oldLocation.Postcode) {
         // Update location if postcode changed
         await updateLocationIfPostcodeChanged(
-          oldLocation.Postcode, 
-          updateData.Location.Postcode, 
+          oldLocation.Postcode,
+          updateData.Location.Postcode,
           updateData.Location
         );
       } else if (!updateData.Location.Location) {
@@ -221,10 +250,18 @@ export const updateService = asyncHandler(async (req: Request, res: Response) =>
       }
     }
 
+    // Denormalise client groups if keys provided
+    const clientGroups = updateData.ClientGroupKeys
+      ? await denormaliseClientGroups(updateData.ClientGroupKeys)
+      : [];
+
     // Update the grouped service
     const updatedService = await GroupedService.findByIdAndUpdate(
-      req.params.id, 
-      updateData, 
+      req.params.id,
+      {
+        ...updateData,
+        ClientGroups: clientGroups
+      },
       { new: true, session }
     );
 

src/models/clientGroupModel.ts

@@ -0,0 +1,15 @@
+import mongoose from "mongoose";
+import { IClientGroup } from "../types/IClientGroup.js";
+
+const clientGroupSchema = new mongoose.Schema({
+  Key: { type: String, required: true },
+  Name: { type: String, required: true },
+  SortPosition: { type: Number, required: true },
+  DocumentCreationDate: { type: Date, required: false },
+  DocumentModifiedDate: { type: Date, required: false },
+  CreatedBy: { type: String, required: false }
+}, { collection: 'ClientGroups', versionKey: false });
+
+const ClientGroup = mongoose.model<IClientGroup>("ClientGroups", clientGroupSchema);
+
+export default ClientGroup;

src/models/groupedServiceModel.ts

@@ -85,6 +85,18 @@ const groupedServiceSchema = new Schema<IGroupedService>({
   Telephone: {
     type: String,
     required: false,
+  },
+  ClientGroupKeys: {
+    type: [String],
+    required: false,
+  },
+  ClientGroups: {
+    type: [{
+      Key: { type: String, required: true },
+      Name: { type: String, required: true },
+      SortPosition: { type: Number, required: true }
+    }],
+    required: false,
   }
 }, { collection: 'GroupedProvidedServices', versionKey: false });
 

src/routes/clientGroupRoutes.ts

@@ -0,0 +1,14 @@
+import express from 'express';
+import { getClientGroups } from '../controllers/clientGroupController.js';
+import { authenticate } from '../middleware/authMiddleware.js';
+
+const router = express.Router();
+
+/**
+ * @route   GET /api/client-groups
+ * @desc    Get all client groups
+ * @access  Private
+ */
+router.get('/', authenticate, getClientGroups);
+
+export default router;

src/schemas/groupedServiceSchema.ts

@@ -92,7 +92,8 @@ export const GroupedServiceSchema = z.object({
   SubCategories: z.array(ServiceSubCategorySchema).min(1, 'At least one subcategory is required'),
   IsTelephoneService: z.boolean().optional().default(false),
   IsAppointmentOnly: z.boolean().optional().default(false),
-  Telephone: z.preprocess(preprocessNullableString, z.string().optional())
+  Telephone: z.preprocess(preprocessNullableString, z.string().optional()),
+  ClientGroupKeys: z.array(z.string()).optional()
 }).refine((data) => {
   // If not open 24/7, not appointment only, and not outreach location, require opening times
   if (!data.IsOpen247 && !data.IsAppointmentOnly && !data.Location.IsOutreachLocation) {

src/types/IClientGroup.ts

@@ -0,0 +1,11 @@
+import { Document } from "mongoose";
+
+export interface IClientGroup extends Document {
+  _id: string;
+  Key: string;
+  Name: string;
+  SortPosition: number;
+  DocumentCreationDate?: Date;
+  DocumentModifiedDate?: Date;
+  CreatedBy?: string;
+}

src/types/index.ts

@@ -3,6 +3,7 @@ export * from './ICity.js';
 export * from './IFaq.js';
 export * from './IUser.js';
 export * from './ILocationLogo.js';
+export * from './IClientGroup.js';
 
 
 // Service provider related types

src/types/organisations/IGroupedService.ts

@@ -3,6 +3,12 @@ import { IOpeningTime } from "./IOpeningTime.js";
 import { ILocation } from "./ILocation.js";
 import { IServiceSubCategory } from "./IServiceSubCategory.js";
 
+export interface IClientGroupRef {
+  Key: string;
+  Name: string;
+  SortPosition: number;
+}
+
 export interface IGroupedService extends Document {
   _id: Types.ObjectId;
   DocumentCreationDate: Date;
@@ -24,4 +30,6 @@ export interface IGroupedService extends Document {
   IsTelephoneService?: boolean;
   IsAppointmentOnly?: boolean;
   Telephone?: string;
+  ClientGroupKeys?: string[];
+  ClientGroups?: IClientGroupRef[];
 }