wip

Author: trinity-y

backend/typescript/services/implementations/userBehaviourService.ts

@@ -0,0 +1,134 @@
+import UserBehaviour from "../../models/userBehaviour.model";
+import {
+  IUserBehaviourService,
+  UserBehaviourRequestDTO,
+  UserBehaviourResponseDTO,
+} from "../interfaces/userBehaviourService";
+import { getErrorMessage } from "../../utilities/errorUtils";
+import logger from "../../utilities/logger";
+
+const Logger = logger(__filename);
+
+class UserBehaviourService implements IUserBehaviourService {
+  /* eslint-disable class-methods-use-this */
+  async getEntity(id: string): Promise<UserBehaviourResponseDTO> {
+    let userBehaviour: UserBehaviour | null;
+    try {
+      userBehaviour = await UserBehaviour.findByPk(id, { raw: true });
+      if (!userBehaviour) {
+        throw new Error(`Entity id ${id} not found`);
+      }
+    } catch (error: unknown) {
+      Logger.error(`Failed to get entity. Reason = ${getErrorMessage(error)}`);
+      throw error;
+    }
+
+    return {
+      behaviour_id: String(userBehaviour.id),
+      level: userBehaviour.level,
+    };
+  }
+
+  async getEntities(): Promise<UserBehaviourResponseDTO[]> { // get
+    try {
+      const entities: Array<UserBehaviour> = await UserBehaviour.findAll({
+        raw: true,
+      });
+      return entities.map((entity) => ({
+        id: String(entity.id),
+        stringField: entity.string_field,
+        intField: entity.int_field,
+        enumField: entity.enum_field,
+        stringArrayField: entity.string_array_field,
+        boolField: entity.bool_field,
+      }));
+    } catch (error: unknown) {
+      Logger.error(
+        `Failed to get entities. Reason = ${getErrorMessage(error)}`,
+      );
+      throw error;
+    }
+  }
+
+  async createEntity(
+    // post
+    entity: UserBehaviourRequestDTO,
+  ): Promise<UserBehaviourResponseDTO> {
+    let newEntity: UserBehaviour | null;
+    try {
+      newEntity = await UserBehaviour.create({
+        string_field: entity.stringField,
+        int_field: entity.intField,
+        enum_field: entity.enumField,
+        string_array_field: entity.stringArrayField,
+        bool_field: entity.boolField,
+      });
+    } catch (error: unknown) {
+      Logger.error(
+        `Failed to create entity. Reason = ${getErrorMessage(error)}`,
+      );
+      throw error;
+    }
+    return {
+      behaviour_id: String(newEntity.id),
+      level: newEntity.int_field,
+    };
+  }
+
+  async updateEntity( // put
+    id: string,
+    entity: UserBehaviourRequestDTO, // ! check format of put
+  ): Promise<UserBehaviourResponseDTO | null> {
+    let resultingEntity: UserBehaviour | null;
+    let updateResult: [number, UserBehaviour[]] | null;
+    try {
+      updateResult = await PgSimpleEntity.update(
+        {
+          string_field: entity.stringField,
+          int_field: entity.intField,
+          enum_field: entity.enumField,
+          string_array_field: entity.stringArrayField,
+          bool_field: entity.boolField,
+        },
+        { where: { id }, returning: true },
+      );
+
+      if (!updateResult[0]) {
+        throw new Error(`Entity id ${id} not found`);
+      }
+      [, [resultingEntity]] = updateResult;
+    } catch (error: unknown) {
+      Logger.error(
+        `Failed to update entity. Reason = ${getErrorMessage(error)}`,
+      );
+      throw error;
+    }
+    return {
+      id: String(resultingEntity.id),
+      stringField: resultingEntity.string_field,
+      intField: resultingEntity.int_field,
+      enumField: resultingEntity.enum_field,
+      stringArrayField: resultingEntity.string_array_field,
+      boolField: resultingEntity.bool_field,
+    };
+  }
+
+  async deleteEntity(id: string): Promise<string> {
+    try {
+      const deleteResult: number | null = await UserBehaviour.destroy({
+        where: { id },
+      });
+      if (!deleteResult) {
+        throw new Error(`Entity id ${id} not found`);
+      }
+      return id;
+    } catch (error: unknown) {
+      Logger.error(
+        `Failed to delete entity. Reason = ${getErrorMessage(error)}`,
+      );
+      throw error;
+    }
+  }
+}
+
+export default UserBehaviourService;

backend/typescript/services/interfaces/userBehaviourService.ts

@@ -0,0 +1,57 @@
+export interface UserBehaviourRequestDTO {
+  behaviour_id: string;
+  level: number;
+}
+
+export interface UserBehaviourResponseDTO {
+  behaviour_id: string;
+  level: number;
+}
+
+export interface IUserBehaviourService {
+  /**
+   * retrieve the SimpleEntity with the given id
+   * @param id SimpleEntity id
+   * @returns requested SimpleEntity
+   * @throws Error if retrieval fails
+   */
+  getEntity(id: string): Promise<UserBehaviourResponseDTO>;
+
+  /**
+   * retrieve all SimpleEntities
+   * @param
+   * @returns returns array of SimpleEntities
+   * @throws Error if retrieval fails
+   */
+  getEntities(): Promise<UserBehaviourResponseDTO[]>;
+
+  /**
+   * create a SimpleEntity with the fields given in the DTO, return created SimpleEntity
+   * @param entity new SimpleEntity
+   * @returns the created SimpleEntity
+   * @throws Error if creation fails
+   */
+  createEntity(
+    entity: UserBehaviourRequestDTO,
+  ): Promise<UserBehaviourResponseDTO>;
+
+  /**
+   * update the SimpleEntity with the given id with fields in the DTO, return updated SimpleEntity
+   * @param id SimpleEntity id
+   * @param entity Updated SimpleEntity
+   * @returns the updated SimpleEntity
+   * @throws Error if update fails
+   */
+  updateEntity(
+    id: string,
+    entity: UserBehaviourRequestDTO,
+  ): Promise<UserBehaviourResponseDTO | null>;
+
+  /**
+   * delete the SimpleEntity with the given id
+   * @param id SimpleEntity id
+   * @returns id of the SimpleEntity deleted
+   * @throws Error if deletion fails
+   */
+  deleteEntity(id: string): Promise<string>;
+}