refactor: improve types and add validation for targetId and targetModel

Author: LuizFNJ

server/history/history.controller.ts

@@ -19,6 +19,11 @@ export class HistoryController {
         @Query() query: HistoryQuery
     ): Promise<HistoryResponse> {
         const { targetId, targetModel } = param;
+
+        if (!targetId || !targetModel) {
+            throw new Error("targetId and targetModel are required");
+        }
+
         try {
             const response = await this.historyService.getHistoryForTarget(
                 targetId,

server/history/history.service.ts

@@ -1,7 +1,7 @@
 import { Injectable, Logger } from "@nestjs/common";
 import { InjectModel } from "@nestjs/mongoose";
 import { Model, Types, isValidObjectId } from "mongoose";
-import { History, HistoryDocument, HistoryType } from "./schema/history.schema";
+import { History, HistoryDocument, HistoryType, TargetModel } from "./schema/history.schema";
 import {
     AfterAndBeforeType,
     HEX24,
@@ -44,12 +44,16 @@ export class HistoryService {
      */
     getHistoryParams(
         dataId: string,
-        targetModel: string,
+        targetModel: TargetModel,
         performedBy: PerformedBy,
-        type: string,
+        type: HistoryType,
         latestChange: AfterAndBeforeType,
         previousChange?: AfterAndBeforeType
     ) {
+        if (!isValidObjectId(dataId)) {
+            throw new Error(`Invalid dataId received: ${dataId}`);
+        }
+
         const date = new Date();
         const targetId = Types.ObjectId(dataId);
         let currentPerformedBy = null;
@@ -60,9 +64,6 @@ export class HistoryService {
             currentPerformedBy = performedBy;
         }
 
-        if (!isValidObjectId(dataId)) {
-            throw new Error(`Invalid dataId received: ${dataId}`);
-        }
 
         return {
             targetId: targetId,
@@ -82,14 +83,16 @@ export class HistoryService {
      * @param data Object with the history data
      * @returns Returns a new history document to database
      */
-    async createHistory(data) {
+    async createHistory(
+        data: Partial<HistoryDocument>
+    ): Promise<HistoryDocument> {
         const newHistory = new this.HistoryModel(data);
         return newHistory.save();
     }
 
     async getHistoryForTarget(
         targetId: string,
-        targetModel: string,
+        targetModel: TargetModel,
         query: HistoryQuery
     ): Promise<HistoryResponse> {
         const page = Math.max(Number(query.page) || 0, 0);
@@ -167,8 +170,8 @@ export class HistoryService {
     }
 
     async getDescriptionForHide(
-        content: IHideableContent, 
-        target: string
+        content: IHideableContent,
+        target: TargetModel
     ) {
         if (!content?._id || !content?.isHidden) {
             return "";

server/history/schema/history.schema.ts

@@ -68,7 +68,7 @@ export class History {
         type: Date,
         required: true,
     })
-    date: mongoose.Date;
+    date: Date;
 }
 
 export const HistorySchema = SchemaFactory.createForClass(History);

server/history/types/history.interfaces.ts

@@ -1,17 +1,19 @@
+import { Roles } from "auth/ability/ability.factory";
+import { HistoryType, TargetModel } from "history/schema/history.schema";
 import { Types } from "mongoose";
 
 export const HEX24 = /^[0-9a-fA-F]{24}$/;
 
 interface HistoryParams {
   targetId: string;
-  targetModel: string;
+  targetModel: TargetModel;
 }
 
 interface HistoryQuery {
   page?: number;
   pageSize?: number;
   order?: "asc" | "desc";
-  type?: string;
+  type?: HistoryType;
 }
 interface HistoryResponse {
   history: HistoryItem[];
@@ -23,9 +25,9 @@ interface HistoryResponse {
 interface HistoryItem {
   _id?: string;
   targetId: Types.ObjectId;
-  targetModel: string;
+  targetModel: TargetModel;
   user?: PerformedBy;
-  type?: string;
+  type?: HistoryType;
   details?: HistoryDetails;
   date?: Date | string;
 }
@@ -37,7 +39,7 @@ interface M2M {
   subject: string;
   scopes: string[];
   role: {
-    main: string;
+    main: Roles.Integration;
   };
   namespace: string;
 }