Added type field to userChallenge entity (#32)

* Added type field to userChallenge entity

* Eslint fix

* Change the case of the enum`s values

* Moved the ChallengeTypeValues variable in to a separate file

* Reuse the ChallengeTypeValues in the validation model

---------

Co-authored-by: Viktor Riabkov <vitya.ryabkov@gmail.com>

src/api/userChallenge/validation.schema.ts

@@ -1,5 +1,7 @@
 import z from 'zod';
 
+import { ChallengeTypeValues } from '~/shared/userChallenge';
+
 export interface FindByParams {
   id: string;
   userId: string;
@@ -10,6 +12,7 @@ export const CreateChallengeSchema = z.object({
   startedAtDate: z.string().date(),
   duration: z.number(),
   description: z.string().max(500).or(z.null()),
+  type: z.enum(ChallengeTypeValues as [string, ...string[]]),
 });
 
 export type CreateChallengeReqPayload = z.infer<typeof CreateChallengeSchema>;

src/database/migrations/20241127102737-add-type-to-userChallenge.js

@@ -0,0 +1,17 @@
+'use strict';
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.addColumn('userChallenge', 'type', {
+      type: Sequelize.TEXT,
+      allowNull: true,
+      unique: false,
+      defaultValue: null,
+    });
+  },
+
+  async down(queryInterface, Sequelize) {
+    await queryInterface.removeColumn('userChallenge', 'type');
+  },
+};

src/database/models/UserChallenge.ts

@@ -3,6 +3,8 @@ import { DataTypes } from 'sequelize';
 import Sequelize from '../connection';
 import { User } from './User';
 
+import { ChallengeTypeValues } from '~/shared/userChallenge';
+
 export const UserChallenge = Sequelize.define(
   'userChallenge',
   {
@@ -45,6 +47,14 @@ export const UserChallenge = Sequelize.define(
       },
     },
 
+    type: {
+      type: DataTypes.ENUM(...ChallengeTypeValues),
+      allowNull: true,
+      validate: {
+        isIn: [ChallengeTypeValues],
+      },
+    },
+
     userId: {
       type: DataTypes.UUIDV4,
       allowNull: false,

src/shared/userChallenge/constants.ts

@@ -0,0 +1,3 @@
+import { ChallengeType } from './types';
+
+export const ChallengeTypeValues = Object.values(ChallengeType);

src/shared/userChallenge/index.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export * from './constants';

src/shared/userChallenge/types.ts

@@ -0,0 +1,8 @@
+export enum ChallengeType {
+  Sport = 'SPORT',
+  Language = 'LANGUAGE',
+  Sugar = 'SUGAR',
+  Water = 'WATER',
+  Sleep = 'SLEEP',
+  Other = 'OTHER',
+}