feat(ratecard): implement CRUD operations and validation for rate cards

worklenz-backend/database/migrations/20250519000000-project-finance-module-tables.sql

@@ -0,0 +1,48 @@
+-- Dropping existing finance_rate_cards table
+DROP TABLE IF EXISTS finance_rate_cards;
+-- Creating table to store rate card details
+CREATE TABLE finance_rate_cards
+(
+    id         UUID PRIMARY KEY                  DEFAULT uuid_generate_v4(),
+    team_id    UUID                     NOT NULL REFERENCES teams (id) ON DELETE CASCADE,
+    name       VARCHAR                  NOT NULL,
+    created_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    updated_at timestamp with time zone NOT NULL DEFAULT CURRENT_TIMESTAMP
+);
+
+-- Dropping existing finance_project_rate_card_roles table
+DROP TABLE IF EXISTS finance_project_rate_card_roles;
+-- Creating table with single id primary key
+CREATE TABLE finance_project_rate_card_roles
+(
+    id         UUID PRIMARY KEY                  DEFAULT uuid_generate_v4(),
+    project_id UUID                     NOT NULL REFERENCES projects (id) ON DELETE CASCADE,
+    role_id    UUID                     NOT NULL REFERENCES roles (id) ON DELETE CASCADE,
+    rate       DECIMAL(10, 2)           NOT NULL CHECK (rate >= 0),
+    created_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    updated_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    CONSTRAINT unique_project_role UNIQUE (project_id, role_id)
+);
+
+-- Dropping existing finance_rate_card_roles table
+DROP TABLE IF EXISTS finance_rate_card_roles;
+-- Creating table to store role-specific rates for rate cards
+CREATE TABLE finance_rate_card_roles
+(
+    rate_card_id UUID                     NOT NULL REFERENCES finance_rate_cards (id) ON DELETE CASCADE,
+    role_id      UUID                     REFERENCES roles (id) ON DELETE SET NULL,
+    rate         DECIMAL(10, 2)           NOT NULL CHECK (rate >= 0),
+    created_at   TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    updated_at   TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP
+);
+
+-- Adding project_rate_card_role_id column to project_members
+ALTER TABLE project_members
+    ADD COLUMN project_rate_card_role_id UUID REFERENCES finance_project_rate_card_roles(id) ON DELETE SET NULL;
+
+-- Adding rate_card column to projects
+ALTER TABLE projects
+ ADD COLUMN rate_card UUID REFERENCES finance_rate_cards(id) ON DELETE SET NULL;
+
+ALTER TABLE finance_rate_cards
+    ADD COLUMN currency TEXT NOT NULL DEFAULT 'LKR';

worklenz-backend/src/controllers/ratecard-controller.ts

@@ -0,0 +1,84 @@
+import { IWorkLenzRequest } from "../interfaces/worklenz-request";
+import { IWorkLenzResponse } from "../interfaces/worklenz-response";
+import db from "../config/db";
+import { ServerResponse } from "../models/server-response";
+import WorklenzControllerBase from "./worklenz-controller-base";
+import HandleExceptions from "../decorators/handle-exceptions";
+
+export default class RateCardController extends WorklenzControllerBase {
+  @HandleExceptions()
+  public static async create(req: IWorkLenzRequest, res: IWorkLenzResponse): Promise<IWorkLenzResponse> {
+    const q = `
+      INSERT INTO finance_rate_cards (team_id, name)
+      VALUES ($1, $2)
+      RETURNING id, name, team_id, created_at, updated_at;
+    `;
+    const result = await db.query(q, [req.user?.team_id || null, req.body.name]);
+    const [data] = result.rows;
+    return res.status(200).send(new ServerResponse(true, data));
+  }
+
+  @HandleExceptions()
+public static async get(req: IWorkLenzRequest, res: IWorkLenzResponse): Promise<IWorkLenzResponse> {
+  const { searchQuery, sortField, sortOrder, size, offset } = this.toPaginationOptions(req.query, "name");
+
+  const q = `
+    SELECT ROW_TO_JSON(rec) AS rate_cards
+    FROM (
+      SELECT COUNT(*) AS total,
+        (
+          SELECT COALESCE(ARRAY_TO_JSON(ARRAY_AGG(ROW_TO_JSON(t))), '[]'::JSON)
+          FROM (
+            SELECT id, name, team_id, created_at, updated_at
+            FROM finance_rate_cards
+            WHERE team_id = $1 ${searchQuery}
+            ORDER BY ${sortField} ${sortOrder}
+            LIMIT $2 OFFSET $3
+          ) t
+        ) AS data
+      FROM finance_rate_cards
+      WHERE team_id = $1 ${searchQuery}
+    ) rec;
+  `;
+  const result = await db.query(q, [req.user?.team_id || null, size, offset]);
+  const [data] = result.rows;
+
+  return res.status(200).send(new ServerResponse(true, data.rate_cards || this.paginatedDatasetDefaultStruct));
+}
+
+  @HandleExceptions()
+  public static async getById(req: IWorkLenzRequest, res: IWorkLenzResponse): Promise<IWorkLenzResponse> {
+    const q = `
+      SELECT id, name, team_id, created_at, updated_at
+      FROM finance_rate_cards
+      WHERE id = $1 AND team_id = $2;
+    `;
+    const result = await db.query(q, [req.params.id, req.user?.team_id || null]);
+    const [data] = result.rows;
+    return res.status(200).send(new ServerResponse(true, data));
+  }
+
+  @HandleExceptions()
+  public static async update(req: IWorkLenzRequest, res: IWorkLenzResponse): Promise<IWorkLenzResponse> {
+    const q = `
+      UPDATE finance_rate_cards
+      SET name = $3, updated_at = NOW()
+      WHERE id = $1 AND team_id = $2
+      RETURNING id, name, team_id, created_at, updated_at;
+    `;
+    const result = await db.query(q, [req.params.id, req.user?.team_id || null, req.body.name]);
+    const [data] = result.rows;
+    return res.status(200).send(new ServerResponse(true, data));
+  }
+
+  @HandleExceptions()
+  public static async deleteById(req: IWorkLenzRequest, res: IWorkLenzResponse): Promise<IWorkLenzResponse> {
+    const q = `
+      DELETE FROM finance_rate_cards
+      WHERE id = $1 AND team_id = $2
+      RETURNING id;
+    `;
+    const result = await db.query(q, [req.params.id, req.user?.team_id || null]);
+    return res.status(200).send(new ServerResponse(true, result.rows.length > 0));
+  }
+}

worklenz-backend/src/middlewares/validators/ratecard-body-validator.ts

@@ -0,0 +1,15 @@
+import {NextFunction} from "express";
+
+import {IWorkLenzRequest} from "../../interfaces/worklenz-request";
+import {IWorkLenzResponse} from "../../interfaces/worklenz-response";
+import {ServerResponse} from "../../models/server-response";
+
+export default function (req: IWorkLenzRequest, res: IWorkLenzResponse, next: NextFunction): IWorkLenzResponse | void {
+  const {name} = req.body;
+  if (!name || name.trim() === "")
+    return res.status(200).send(new ServerResponse(false, null, "Name is required"));
+
+  req.body.name = req.body.name.trim();
+
+  return next();
+}

worklenz-backend/src/routes/apis/index.ts

@@ -56,7 +56,9 @@ import billingApiRouter from "./billing-api-router";
 import taskDependenciesApiRouter from "./task-dependencies-api-router";
 
 import taskRecurringApiRouter from "./task-recurring-api-router";
+
 import customColumnsApiRouter from "./custom-columns-api-router";
+import ratecardApiRouter from "./ratecard-api-router";
 
 const api = express.Router();
 
@@ -64,6 +66,7 @@ api.use("/projects", projectsApiRouter);
 api.use("/team-members", teamMembersApiRouter);
 api.use("/job-titles", jobTitlesApiRouter);
 api.use("/clients", clientsApiRouter);
+api.use("/rate-cards", ratecardApiRouter);
 api.use("/teams", teamsApiRouter);
 api.use("/tasks", tasksApiRouter);
 api.use("/settings", settingsApiRouter);

worklenz-backend/src/routes/apis/ratecard-api-router.ts

@@ -0,0 +1,48 @@
+import express from "express";
+
+import RateCardController from "../../controllers/ratecard-controller";
+
+
+import idParamValidator from "../../middlewares/validators/id-param-validator";
+import teamOwnerOrAdminValidator from "../../middlewares/validators/team-owner-or-admin-validator";
+import safeControllerFunction from "../../shared/safe-controller-function";
+import projectManagerValidator from "../../middlewares/validators/project-manager-validator";
+import ratecardBodyValidator from "../../middlewares/validators/ratecard-body-validator";
+
+const ratecardApiRouter = express.Router();
+
+ratecardApiRouter.post(
+  "/",
+  projectManagerValidator,
+  ratecardBodyValidator,
+  safeControllerFunction(RateCardController.create)
+);
+
+ratecardApiRouter.get(
+  "/",
+  safeControllerFunction(RateCardController.get)
+);
+
+ratecardApiRouter.get(
+  "/:id",
+  teamOwnerOrAdminValidator,
+  idParamValidator,
+  safeControllerFunction(RateCardController.getById)
+);
+
+ratecardApiRouter.put(
+  "/:id",
+  teamOwnerOrAdminValidator,
+  ratecardBodyValidator,
+  idParamValidator,
+  safeControllerFunction(RateCardController.update)
+);
+
+ratecardApiRouter.delete(
+  "/:id",
+  teamOwnerOrAdminValidator,
+  idParamValidator,
+  safeControllerFunction(RateCardController.deleteById)
+);
+
+export default ratecardApiRouter;

worklenz-frontend/src/api/settings/rate-cards/rate-cards.api.service.ts

@@ -0,0 +1,49 @@
+import apiClient from '@api/api-client';
+import { API_BASE_URL } from '@/shared/constants';
+import { IServerResponse } from '@/types/common.types';
+import { IJobTitle, IJobTitlesViewModel } from '@/types/job.types';
+import { toQueryString } from '@/utils/toQueryString';
+
+type IRatecard = {
+  id: string;}
+type IRatecardViewModel = {
+  id: string;}
+
+const rootUrl = `${API_BASE_URL}/rate-cards`;
+
+export const rateCardApiService = {
+    async getRateCards(
+    index: number,
+    size: number,
+    field: string | null,
+    order: string | null,
+    search?: string | null
+  ): Promise<IServerResponse<IRatecardViewModel>> {
+    const s = encodeURIComponent(search || '');
+    const queryString = toQueryString({ index, size, field, order, search: s });
+    const response = await apiClient.get<IServerResponse<IRatecardViewModel>>(
+      `${rootUrl}${queryString}`
+    );
+    return response.data;
+  },
+  async getRateCardById(id: string): Promise<IServerResponse<IRatecard>> {
+    const response = await apiClient.get<IServerResponse<IRatecard>>(`${rootUrl}/${id}`);
+    return response.data;
+  },
+
+  async createRateCard(body: IRatecard): Promise<IServerResponse<IRatecard>> {
+    const response = await apiClient.post<IServerResponse<IRatecard>>(rootUrl, body);
+    return response.data;
+  },
+
+  async updateRateCard(id: string, body: IRatecard): Promise<IServerResponse<IRatecard>> {
+    const response = await apiClient.put<IServerResponse<IRatecard>>(`${rootUrl}/${id}`, body);
+    return response.data;
+  },
+
+  async deleteRateCard(id: string): Promise<IServerResponse<void>> {
+    const response = await apiClient.delete<IServerResponse<void>>(`${rootUrl}/${id}`);
+    return response.data;
+  },
+
+};

worklenz-frontend/src/features/navbar/navRoutes.ts

@@ -1,7 +1,7 @@
 export type NavRoutesType = {
   name: string;
   path: string;
-  adminOnly: boolean;
+  adminOnly?: boolean;
   freePlanFeature?: boolean;
 };