feat(api): add organization journal

Author: Johan Book

services/api/src/core/journal/application/contracts/queries/get-current-organization-journal.query.ts

@@ -0,0 +1,14 @@
+import { Type } from "class-transformer";
+import { IsDate } from "class-validator";
+
+import { BaseQuery } from "src/core/query";
+
+export class GetCurrentOrganizationJournalQuery extends BaseQuery {
+  @IsDate()
+  @Type(() => Date)
+  from!: Date;
+
+  @IsDate()
+  @Type(() => Date)
+  to!: Date;
+}

services/api/src/core/journal/application/contracts/queries/get-journal.query.ts renamed to services/api/src/core/journal/application/contracts/queries/get-profile-journal.query.ts

@@ -3,7 +3,7 @@ import { IsDate } from "class-validator";
 
 import { BaseQuery } from "src/core/query";
 
-export class GetJournalQuery extends BaseQuery {
+export class GetProfileJournalQuery extends BaseQuery {
   @IsDate()
   @Type(() => Date)
   from!: Date;

services/api/src/core/journal/application/handlers/query-handlers/get-current-organization-journal.handler.ts

@@ -0,0 +1,57 @@
+import { IQueryHandler, QueryHandler } from "@nestjs/cqrs";
+import { InjectRepository } from "@nestjs/typeorm";
+import { Between, Repository } from "typeorm";
+
+import { UserIdService } from "src/core/authentication";
+import { map, mapArray } from "src/core/mapper";
+import { QueryService } from "src/core/query";
+
+import { JournalEntry } from "../../../infrastructure/entities/journal-entry.entity";
+import { JournalDetails } from "../../contracts/dtos/journal-details.dto";
+import { JournalEntryDetails } from "../../contracts/dtos/journal-entry-details.dto";
+import { GetCurrentOrganizationJournalQuery } from "../../contracts/queries/get-current-organization-journal.query";
+
+function formatCommandName(commandName: string): string {
+  return commandName.replace(/Command$/, "");
+}
+
+@QueryHandler(GetCurrentOrganizationJournalQuery)
+export class GetCurrentOrganizationJournalHandler
+  implements IQueryHandler<GetCurrentOrganizationJournalQuery, JournalDetails>
+{
+  constructor(
+    @InjectRepository(JournalEntry)
+    private readonly journalEntries: Repository<JournalEntry>,
+    private readonly queryService: QueryService<JournalEntry>,
+    private readonly userIdService: UserIdService,
+  ) {}
+
+  async execute(query: GetCurrentOrganizationJournalQuery) {
+    const userId = this.userIdService.getUserId();
+
+    const foundJournalEntries = await this.queryService.find(
+      this.journalEntries,
+      {
+        default: {
+          order: { created: "desc" },
+        },
+        query,
+        required: {
+          where: {
+            created: Between(query.from, query.to),
+            userId,
+          },
+        },
+      },
+    );
+
+    return map(JournalDetails, {
+      entries: mapArray(JournalEntryDetails, foundJournalEntries, (entry) => ({
+        commandName: formatCommandName(entry.commandName),
+        created: entry.created,
+        id: entry.id,
+        payload: entry.payload,
+      })),
+    });
+  }
+}

services/api/src/core/journal/application/handlers/query-handlers/get-journal.handler.ts renamed to services/api/src/core/journal/application/handlers/query-handlers/get-profile-journal.handler.ts

@@ -1,6 +1,6 @@
 import { IQueryHandler, QueryHandler } from "@nestjs/cqrs";
 import { InjectRepository } from "@nestjs/typeorm";
-import { And, LessThan, MoreThan, Repository } from "typeorm";
+import { Between, Repository } from "typeorm";
 
 import { UserIdService } from "src/core/authentication";
 import { map, mapArray } from "src/core/mapper";
@@ -9,15 +9,15 @@ import { QueryService } from "src/core/query";
 import { JournalEntry } from "../../../infrastructure/entities/journal-entry.entity";
 import { JournalDetails } from "../../contracts/dtos/journal-details.dto";
 import { JournalEntryDetails } from "../../contracts/dtos/journal-entry-details.dto";
-import { GetJournalQuery } from "../../contracts/queries/get-journal.query";
+import { GetProfileJournalQuery } from "../../contracts/queries/get-profile-journal.query";
 
 function formatCommandName(commandName: string): string {
   return commandName.replace(/Command$/, "");
 }
 
-@QueryHandler(GetJournalQuery)
-export class GetJournalHandler
-  implements IQueryHandler<GetJournalQuery, JournalDetails>
+@QueryHandler(GetProfileJournalQuery)
+export class GetProfileJournalHandler
+  implements IQueryHandler<GetProfileJournalQuery, JournalDetails>
 {
   constructor(
     @InjectRepository(JournalEntry)
@@ -26,7 +26,7 @@ export class GetJournalHandler
     private readonly userIdService: UserIdService,
   ) {}
 
-  async execute(query: GetJournalQuery) {
+  async execute(query: GetProfileJournalQuery) {
     const userId = this.userIdService.getUserId();
 
     const foundJournalEntries = await this.queryService.find(
@@ -38,7 +38,7 @@ export class GetJournalHandler
         query,
         required: {
           where: {
-            created: And(LessThan(query.to), MoreThan(query.from)),
+            created: Between(query.from, query.to),
             userId,
           },
         },

services/api/src/core/journal/client/controllers/journal.controller.ts

@@ -3,15 +3,26 @@ import { QueryBus } from "@nestjs/cqrs";
 import { ApiTags } from "@nestjs/swagger";
 
 import { JournalDetails } from "../../application/contracts/dtos/journal-details.dto";
+import { GetCurrentOrganizationJournalQuery } from "../../application/contracts/queries/get-current-organization-journal.query";
 import { GetJournalQuery } from "../../application/contracts/queries/get-journal.query";
+import { GetProfileJournalQuery } from "../../application/contracts/queries/get-profile-journal.query";
 
 @Controller("journal")
 @ApiTags("journal")
 export class JournalController {
   constructor(private queryBus: QueryBus) {}
 
-  @Get()
-  async getJournal(@Query() query: GetJournalQuery): Promise<JournalDetails> {
+  @Get("/current-organization")
+  async getCurrentOrganizationJournal(
+    @Query() query: GetCurrentOrganizationJournalQuery,
+  ): Promise<JournalDetails> {
+    return await this.queryBus.execute(query);
+  }
+
+  @Get("/profile")
+  async getProfileJournal(
+    @Query() query: GetProfileJournalQuery,
+  ): Promise<JournalDetails> {
     return await this.queryBus.execute(query);
   }
 }

services/api/src/core/journal/journal.module.ts

@@ -7,7 +7,8 @@ import { QueryModule } from "src/core/query/query.module";
 
 import { AuthenticationModule } from "../authentication/authentication.module";
 import { CreateJournalEntryHandler } from "./application/handlers/command-handlers/create-journal-entry.handler";
-import { GetJournalHandler } from "./application/handlers/query-handlers/get-journal.handler";
+import { GetCurrentOrganizationJournalHandler } from "./application/handlers/query-handlers/get-current-organization-journal.handler";
+import { GetProfileJournalHandler } from "./application/handlers/query-handlers/get-profile-journal.handler";
 import { JournalController } from "./client/controllers/journal.controller";
 import { JournalEntry } from "./infrastructure/entities/journal-entry.entity";
 import { JournalLogger } from "./journal.listener";
@@ -21,6 +22,11 @@ import { JournalLogger } from "./journal.listener";
     QueryModule,
   ],
   controllers: [JournalController],
-  providers: [CreateJournalEntryHandler, GetJournalHandler, JournalLogger],
+  providers: [
+    CreateJournalEntryHandler,
+    GetCurrentOrganizationJournalHandler,
+    GetProfileJournalHandler,
+    JournalLogger,
+  ],
 })
 export class JournalModule {}