Feat: Weeklies routes (#118)

Original PR #92 

* New route: `POST /assos/:assoId/daymail`
* Decorator `HasSomeAmong` is now applied to classes instead of
properties

Author: TeddyRoncin

.env.dist

@@ -40,3 +40,7 @@ SMTP_REJECT_UNAUTHORIZED=false
 SMTP_SERVER_NAME=EtuUTT
 SMTP_SENDING_NAME=EtuUTT
 SMTP_SENDING_EMAIL=etuutt@utt.fr
+
+# Weekly
+WEEKLY_SEND_DAY=1
+WEEKLY_SEND_HOUR=8

.env.test.dist

@@ -37,3 +37,7 @@ SMTP_REJECT_UNAUTHORIZED=false
 SMTP_SERVER_NAME=EtuUTT
 SMTP_SENDING_NAME=EtuUTT
 SMTP_SENDING_EMAIL=etuutt@utt.fr
+
+# Weekly
+WEEKLY_SEND_DAY=1
+WEEKLY_SEND_HOUR=8

migration/etuutt_old/modules/user.ts

@@ -72,7 +72,7 @@ export async function migrateUsers(
           },
           preference: {
             create: {
-              wantDaymail: user.daymail,
+              wantWeekly: user.daymail,
               language: user.language,
               wantDayNotif: false,
               wantDiscordUtt: user.wantsJoinUTTDiscord,

prisma/schema.prisma

@@ -65,7 +65,7 @@ model Asso {
   descriptionShortTranslation Translation?         @relation(name: "descriptionShortTranslation", fields: [descriptionShortTranslationId], references: [id], onDelete: Cascade)
   descriptionTranslation      Translation?         @relation(name: "descriptionTranslation", fields: [descriptionTranslationId], references: [id], onDelete: Cascade)
   assoMemberships             AssoMembership[]
-  assoMessages                AssoMessage[]
+  weeklies                    AssoWeekly[]
   events                      Event[]
   assoMembershipRoles         AssoMembershipRole[]
   assoAccount                 User                 @relation(fields: [assoAccountId], references: [id], onDelete: Cascade)
@@ -103,19 +103,19 @@ model AssoMembershipRole {
   asso            Asso             @relation(fields: [assoId], references: [id])
 }
 
-model AssoMessage {
+model AssoWeekly {
   id                 String   @id @default(uuid())
-  date               DateTime
-  sendToMobile       Boolean
-  sendAsDaymail      Boolean
   createdAt          DateTime @default(now())
   assoId             String
   titleTranslationId String   @unique
   bodyTranslationId  String   @unique
+  date               DateTime
 
   asso             Asso        @relation(fields: [assoId], references: [id])
   titleTranslation Translation @relation(name: "titleTranslation", fields: [titleTranslationId], references: [id], onDelete: Cascade)
   bodyTranslation  Translation @relation(name: "bodyTranslation", fields: [bodyTranslationId], references: [id], onDelete: Cascade)
+
+  @@unique([assoId, date])
 }
 
 model Event {
@@ -249,8 +249,8 @@ model Translation {
 
   assoDescription                      Asso?                        @relation("descriptionTranslation")
   assoDescriptionShort                 Asso?                        @relation("descriptionShortTranslation")
-  assoMessageTitle                     AssoMessage?                 @relation("titleTranslation")
-  assoMessageTitleBody                 AssoMessage?                 @relation("bodyTranslation")
+  assoWeeklyTitle                      AssoWeekly?                  @relation("titleTranslation")
+  assoWeeklyTitleBody                  AssoWeekly?                  @relation("bodyTranslation")
   eventDescription                     Event?                       @relation("descriptionTranslation")
   eventTitle                           Event?                       @relation("titleTranslation")
   ueofInfo                             UeofInfo?                    @relation("ueofInfoObjectivesTranslation")
@@ -752,7 +752,7 @@ model UserHomepageWidget {
 model UserPreference {
   id             String   @id @default(uuid())
   language       Language @default(fr)
-  wantDaymail    Boolean  @default(false)
+  wantWeekly     Boolean  @default(false)
   wantDayNotif   Boolean  @default(false)
   wantDiscordUtt Boolean  @default(false)
 

src/app.dto.ts

@@ -3,6 +3,9 @@ import { applyDecorators, HttpStatus, Injectable } from '@nestjs/common';
 import * as ApiResponses from '@nestjs/swagger';
 import { ApiProperty } from '@nestjs/swagger';
 import { Type } from '@nestjs/common/interfaces/type.interface';
+import { IsOptional, IsString } from 'class-validator';
+import { HasSomeAmong } from './validation';
+import { languages } from './utils';
 
 // Redefine the mixin function in node_modules/.pnpm/@nestjs+common@<version>_class-transformer@<version>_class-validator@<version>_reflect-metadata@<version>_rxjs@<version>/node_modules/@nestjs/common/decorators/core/injectable.decorator.js
 // This implementation allows to give a name to the class
@@ -44,3 +47,27 @@ export function paginatedResponseDto<TBase extends Constructor>(Base: TBase) {
   }
   return mixin(ResponseDto, `${Base.name}$Paginated`); // This is important otherwise you will get always the same instance
 }
+
+@HasSomeAmong(...languages)
+export class TranslationReqDto {
+  @IsString()
+  @IsOptional()
+  fr?: string;
+
+  @IsString()
+  @IsOptional()
+  en?: string;
+
+  @IsString()
+  @IsOptional()
+  es?: string;
+
+  @IsString()
+  @IsOptional()
+  de?: string;
+
+  @IsString()
+  @IsOptional()
+  zh?: string;
+}
+

src/assos/assos.controller.ts

@@ -24,6 +24,7 @@ import AssosMemberCreateReqDto from './dto/req/assos-member-create.dto';
 import AssosMemberUpdateReqDto from './dto/req/assos-member-update.dto';
 import AssoMembershipResDto from './dto/res/assos-membership-res.dto';
 import UsersService from '../users/users.service';
+import { ConfigModule } from '../config/config.module';
 import AssosUpdateReqDto from './dto/req/assos-update-req.dto';
 import { ImageMediaPreset } from '@prisma/client';
 
@@ -33,6 +34,7 @@ export class AssosController {
   constructor(
     readonly assosService: AssosService,
     readonly userService: UsersService,
+    readonly config: ConfigModule,
     readonly mediaService: ImageMediaService,
   ) {}
 

src/assos/assos.module.ts

@@ -3,14 +3,17 @@ import { AssosController } from './assos.controller';
 import { AssosService } from './assos.service';
 import { ImageMediaModule } from '../media/image/imagemedia.module';
 import UsersService from '../users/users.service';
+import WeeklyWithoutAssoidController from './weekly/weekly-without-asso-id.controller';
+import { WeeklyWithAssoIdController } from './weekly/weekly-with-asso-id.controller';
+import WeeklyService from './weekly/weekly.service';
 
 /**
  * Defines the `Assos` module. This module handles all routes prefixed by `/assos`.
  * Includes `Assos` listing, details
  */
 @Module({
-  controllers: [AssosController],
-  providers: [AssosService, UsersService],
+  controllers: [AssosController, WeeklyWithoutAssoidController, WeeklyWithAssoIdController],
+  providers: [AssosService, WeeklyService, UsersService],
   imports: [ImageMediaModule],
 })
 export class AssosModule {}

src/assos/interfaces/weekly.interface.ts

@@ -0,0 +1,28 @@
+import { Prisma, PrismaClient } from '@prisma/client';
+import { generateCustomModel } from '../../prisma/prisma.service';
+import { pick, translationSelect } from '../../utils';
+import { Translation } from '../../prisma/types';
+
+const ASSO_WEEKLY_SELECT_FILTER = {
+  select: {
+    id: true,
+    assoId: true,
+    createdAt: true,
+    titleTranslation: translationSelect,
+    bodyTranslation: translationSelect,
+    date: true,
+  },
+  orderBy: { date: 'asc'}
+} as const satisfies Prisma.AssoWeeklyFindManyArgs;
+
+export type UnformattedAssoWeekly = Prisma.AssoWeeklyGetPayload<typeof ASSO_WEEKLY_SELECT_FILTER>;
+export type AssoWeekly = Pick<UnformattedAssoWeekly, 'id' | 'assoId' | 'createdAt' | 'date'> & { title: Translation, message: Translation }
+
+export const generateCustomAssoWeeklyModel = (prisma: PrismaClient) =>
+  generateCustomModel(prisma, 'assoWeekly', ASSO_WEEKLY_SELECT_FILTER, formatAssoWeekly);
+
+function formatAssoWeekly(_: PrismaClient, r: UnformattedAssoWeekly): AssoWeekly {
+  return {
+    ...pick(r, 'id', 'assoId', 'createdAt', 'date'), title: r.titleTranslation, message: r.bodyTranslation
+  }
+}

src/assos/weekly/dto/req/weekly-req.dto.ts

@@ -0,0 +1,22 @@
+import { Type } from 'class-transformer';
+import { IsDate, IsNotEmpty, ValidateNested } from 'class-validator';
+import { TranslationReqDto } from '../../../../app.dto';
+import { IsWeekDate } from '../../../../validation';
+
+export default class WeeklyReqDto {
+  @ValidateNested()
+  @IsNotEmpty()
+  @Type(() => TranslationReqDto)
+  title: TranslationReqDto
+
+  @ValidateNested()
+  @IsNotEmpty()
+  @Type(() => TranslationReqDto)
+  message: TranslationReqDto;
+
+  @IsDate()
+  @IsNotEmpty()
+  @Type(() => Date)
+  @IsWeekDate()
+  date: Date;
+}

src/assos/weekly/dto/req/weekly-search-req.dto.ts

@@ -0,0 +1,17 @@
+import { IsDate, IsInt, IsOptional } from 'class-validator';
+import { Type } from 'class-transformer';
+
+export default class WeeklySearchReqDto {
+  @IsDate()
+  @Type(() => Date)
+  from?: Date;
+
+  @IsOptional()
+  @IsDate()
+  @Type(() => Date)
+  to?: Date;
+
+  @IsOptional()
+  @IsInt()
+  page: number = 1;
+}