Merge pull request #9 from chingu-x/dev

Dan-Y-Ko · web-flow · commit ba73ead1743d · 2025-01-23T18:55:16.000-05:00
release: user module
diff --git a/package.json b/package.json
@@ -70,12 +70,18 @@
     "./test": {
       "import": "./dist/test/index.js",
       "types": "./dist/test/index.d.ts"
+    },
+    "./user": {
+      "import": "./dist/user/index.js",
+      "types": "./dist/user/index.d.ts"
     }
   },
   "dependencies": {
     "axios": "^1.7.9",
+    "date-fns": "^4.1.0",
+    "date-fns-tz": "^3.2.0",
     "dotenv": "^16.4.7",
     "reflect-metadata": "^0.2.2",
     "tsyringe": "^4.8.0"
   }
-}
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/auth/index.ts b/src/auth/index.ts
@@ -1,6 +1,5 @@
 export { AuthClientAdapter } from "./adapters/primary/authClientAdapter";
 export { AuthApiAdapter } from "./adapters/secondary/authApiAdapter";
-export { default as AuthUrls } from "./application/constants/authUrls";
 export {
   LoginRequestDto,
   RequestResetPasswordDto,
diff --git a/src/config.ts b/src/config.ts
@@ -7,10 +7,14 @@ import { LogoutUsecase } from "./auth/application/usecases/logoutUsecase";
 import { RequestResetPasswordUsecase } from "./auth/application/usecases/requestResetPasswordUsecase";
 import { ResetPasswordUsecase } from "./auth/application/usecases/resetPasswordUsecase";
 import { AuthClientAdapter } from "./auth/adapters/primary/authClientAdapter";
+import { UserApiAdapter } from "./user/adapters/secondary/userApiAdapter";
+import { GetUserUsecase } from "./user/application/usecases/getUserUsecase";
+import { GetChinguMemberStatusUsecase } from "./user/application/usecases/getChinguMemberStatusUsecase";
+import { UserClientAdapter } from "./user/adapters/primary/userClientAdapter";
 
 container.register(TYPES.RestApiPort, { useClass: AxiosAdapter });
 container.register(TYPES.AuthApiPort, { useClass: AuthApiAdapter });
-// container.register(TYPES.UserApiPort, { useClass: UserApiAdapter });
+container.register(TYPES.UserApiPort, { useClass: UserApiAdapter });
 container.register(TYPES.LoginUsecase, { useClass: LoginUsecase });
 container.register(TYPES.LogoutUsecase, { useClass: LogoutUsecase });
 container.register(TYPES.RequestResetPasswordUsecase, {
@@ -20,11 +24,11 @@ container.register(TYPES.ResetPasswordUsecase, {
   useClass: ResetPasswordUsecase,
 });
 container.register(TYPES.AuthClientAdapter, { useClass: AuthClientAdapter });
-// container.register(TYPES.GetUserUsecase, { useClass: GetUserUsecase });
-// container.register(TYPES.GetChinguMemberStatusUsecase, {
-//   useClass: GetChinguMemberStatusUsecase,
-// });
-// container.register(TYPES.UserClientAdapter, { useClass: UserClientAdapter });
+container.register(TYPES.GetUserUsecase, { useClass: GetUserUsecase });
+container.register(TYPES.GetChinguMemberStatusUsecase, {
+  useClass: GetChinguMemberStatusUsecase,
+});
+container.register(TYPES.UserClientAdapter, { useClass: UserClientAdapter });
 // container.register(TYPES.VoyageTeamClientAdapter, {
 //   useClass: VoyageTeamClientAdapter,
 // });
diff --git a/src/rest-api/index.ts b/src/rest-api/index.ts
diff --git a/src/types.ts b/src/types.ts
@@ -1,5 +1,5 @@
 import type { InjectionToken } from "tsyringe";
-import type { RestApiPort } from "./rest-api";
+import type { RestApiPort } from "./rest-api/ports/secondary/restApiPort";
 import type {
   AuthApiPort,
   AuthClientAdapter,
@@ -8,12 +8,16 @@ import type {
   RequestResetPasswordUsecase,
   ResetPasswordUsecase,
 } from "./auth";
+import type { UserApiPort } from "./user/ports/secondary/userApiPort";
+import type { UserClientAdapter } from "./user/adapters/primary/userClientAdapter";
+import type { GetUserUsecase } from "./user/application/usecases/getUserUsecase";
+import type { GetChinguMemberStatusUsecase } from "./user/application/usecases/getChinguMemberStatusUsecase";
 
 export const TYPES = {
   /* Ports */
   RestApiPort: Symbol.for("RestApiPort") as InjectionToken<RestApiPort>,
   AuthApiPort: Symbol.for("AuthApiPort") as InjectionToken<AuthApiPort>,
-  // UserApiPort: Symbol.for("UserApiPort") as InjectionToken<UserApiPort>,
+  UserApiPort: Symbol.for("UserApiPort") as InjectionToken<UserApiPort>,
   // VoyageTeamClientPort: Symbol.for(
   //   "VoyageTeamClientPort"
   // ) as InjectionToken<VoyageTeamClientPort>,
@@ -22,22 +26,22 @@ export const TYPES = {
   AuthClientAdapter: Symbol.for(
     "AuthClientAdapter",
   ) as InjectionToken<AuthClientAdapter>,
-  // UserClientAdapter: Symbol.for(
-  //   "UserClientAdapter"
-  // ) as InjectionToken<UserClientAdapter>,
+  UserClientAdapter: Symbol.for(
+    "UserClientAdapter",
+  ) as InjectionToken<UserClientAdapter>,
   // VoyageTeamClientAdapter: Symbol.for(
   //   "VoyageTeamClientAdapter"
   // ) as InjectionToken<VoyageTeamClientAdapter>,
 
   /* UseCases */
   LoginUsecase: Symbol.for("LoginUsecase") as InjectionToken<LoginUsecase>,
   LogoutUsecase: Symbol.for("LogoutUsecase") as InjectionToken<LogoutUsecase>,
-  // GetUserUsecase: Symbol.for(
-  //   "GetUserUsecase"
-  // ) as InjectionToken<GetUserUsecase>,
-  // GetChinguMemberStatusUsecase: Symbol.for(
-  //   "GetChinguMemberStatusUsecase"
-  // ) as InjectionToken<GetChinguMemberStatusUsecase>,
+  GetUserUsecase: Symbol.for(
+    "GetUserUsecase",
+  ) as InjectionToken<GetUserUsecase>,
+  GetChinguMemberStatusUsecase: Symbol.for(
+    "GetChinguMemberStatusUsecase",
+  ) as InjectionToken<GetChinguMemberStatusUsecase>,
   RequestResetPasswordUsecase: Symbol.for(
     "RequestResetPasswordUsecase",
   ) as InjectionToken<RequestResetPasswordUsecase>,
diff --git a/src/user/adapters/primary/userClientAdapter.ts b/src/user/adapters/primary/userClientAdapter.ts
@@ -0,0 +1,31 @@
+import { inject, injectable } from "tsyringe";
+import { TYPES } from "@/types";
+import { UserClientPort } from "@/user/ports/primary/userClientPort";
+import {
+  GetChinguMemberStatusResponseDto,
+  GetUserResponseDto,
+} from "@/user/application/dtos/response.dto";
+import { GetUserUsecase } from "@/user/application/usecases/getUserUsecase";
+import { GetUserRequestDto } from "@/user/application/dtos/request.dtos";
+import { GetChinguMemberStatusUsecase } from "@/user/application/usecases/getChinguMemberStatusUsecase";
+
+@injectable()
+export class UserClientAdapter implements UserClientPort {
+  constructor(
+    @inject(TYPES.GetUserUsecase)
+    private readonly getUserUsecase: GetUserUsecase,
+
+    @inject(TYPES.GetChinguMemberStatusUsecase)
+    private readonly getChinguMemberStatusUsecase: GetChinguMemberStatusUsecase,
+  ) {}
+
+  async getUser(): Promise<GetUserResponseDto> {
+    return await this.getUserUsecase.execute();
+  }
+
+  getChinguMemberStatus(
+    user: GetUserRequestDto,
+  ): GetChinguMemberStatusResponseDto {
+    return this.getChinguMemberStatusUsecase.execute(user);
+  }
+}
diff --git a/src/user/adapters/secondary/userApiAdapter.ts b/src/user/adapters/secondary/userApiAdapter.ts
@@ -0,0 +1,20 @@
+import { inject, injectable } from "tsyringe";
+import { TYPES } from "@/types";
+import { RestApiPort } from "@/rest-api/ports/secondary/restApiPort";
+import { UserApiPort } from "@/user/ports/secondary/userApiPort";
+import { GetUserResponseDto } from "@/user/application/dtos/response.dto";
+import UserUrls from "@/user/application/constants/userUrls";
+
+@injectable()
+export class UserApiAdapter implements UserApiPort {
+  constructor(
+    @inject(TYPES.RestApiPort)
+    private readonly apiClient: RestApiPort,
+  ) {}
+
+  async getUser(): Promise<GetUserResponseDto> {
+    return await this.apiClient.get({
+      url: UserUrls.getUser(),
+    });
+  }
+}
diff --git a/src/user/application/constants/userUrls.ts b/src/user/application/constants/userUrls.ts
@@ -0,0 +1,7 @@
+const UserUrls = {
+  getUser() {
+    return "/api/v1/users/me";
+  },
+} as const;
+
+export default UserUrls;
diff --git a/src/user/application/dtos/request.dtos.ts b/src/user/application/dtos/request.dtos.ts
@@ -0,0 +1,3 @@
+import type { User } from "@/user/application/types";
+
+export type GetUserRequestDto = User;
diff --git a/src/user/application/dtos/response.dto.ts b/src/user/application/dtos/response.dto.ts
@@ -0,0 +1,5 @@
+import { type User } from "@/user/application/types";
+
+export type GetUserResponseDto = User;
+
+export type GetChinguMemberStatusResponseDto = boolean;
diff --git a/src/user/application/types/index.ts b/src/user/application/types/index.ts
@@ -0,0 +1,49 @@
+// import { type VoyageTeamMember } from "@/modules/voyage-team/application/dtos/response.dto";
+
+export interface User {
+  id: string;
+  firstName: string;
+  lastName: string;
+  countryCode: string;
+  oAuthProfiles: {
+    provider: {
+      name: providerType;
+    };
+    providerUsername: string;
+  }[];
+  email: string;
+  timezone: string;
+  avatar: string;
+  voyageTeamMembers: VoyageTeamMember[];
+  sprintCheckIn: number[];
+  currentDateInUserTimezone: Date | null;
+}
+
+type providerType = "discord";
+
+// remove later
+
+export interface VoyageTeamMember {
+  id: number;
+  voyageTeamId: number;
+  voyageTeam: VoyageTeam;
+  voyageRole: VoyageRole;
+}
+
+interface Voyage {
+  status: VoyageStatus;
+}
+
+interface VoyageTeam {
+  name: string;
+  voyage: Voyage;
+  projectSubmitted: boolean;
+}
+
+export interface VoyageRole {
+  name: string;
+}
+
+export interface VoyageStatus {
+  name: string;
+}
diff --git a/src/user/application/usecases/getChinguMemberStatusUsecase.ts b/src/user/application/usecases/getChinguMemberStatusUsecase.ts
@@ -0,0 +1,16 @@
+import { injectable } from "tsyringe";
+import { GetChinguMemberStatusResponseDto } from "@/user/application/dtos/response.dto";
+import { GetUserRequestDto } from "@/user/application/dtos/request.dtos";
+
+@injectable()
+export class GetChinguMemberStatusUsecase {
+  execute(user: GetUserRequestDto): GetChinguMemberStatusResponseDto {
+    const data = user.voyageTeamMembers;
+    if (data.length === 0) {
+      return false;
+    }
+    return data.some(
+      (member) => member.voyageTeam.voyage.status.name === "Active",
+    );
+  }
+}
diff --git a/src/user/application/usecases/getUserUsecase.ts b/src/user/application/usecases/getUserUsecase.ts
@@ -0,0 +1,34 @@
+import { inject, injectable } from "tsyringe";
+import { TYPES } from "@/types";
+import { UserApiPort } from "@/user/ports/secondary/userApiPort";
+import { GetUserResponseDto } from "@/user/application/dtos/response.dto";
+import { transformDateToUserTimezone } from "@/user/application/utils/dateTransform";
+
+@injectable()
+export class GetUserUsecase {
+  constructor(
+    @inject(TYPES.UserApiPort)
+    private readonly userApi: UserApiPort,
+  ) {}
+
+  async execute(): Promise<GetUserResponseDto> {
+    const data = await this.userApi.getUser();
+
+    const userWithDate = {
+      ...data,
+      currentDateInUserTimezone: transformDateToUserTimezone(
+        currentDate,
+        data.timezone,
+      ),
+    };
+
+    return userWithDate;
+  }
+}
+
+// refactor below code to separate module when ready
+
+const currentDate =
+  process.env.NODE_ENV === "development"
+    ? new Date(2024, 5, 1, 12)
+    : new Date();
diff --git a/src/user/application/utils/dateTransform.ts b/src/user/application/utils/dateTransform.ts
@@ -0,0 +1,9 @@
+import { formatInTimeZone } from "date-fns-tz";
+
+export function transformDateToUserTimezone(
+  date: Date,
+  timezone: string,
+): Date {
+  const formattedDate = formatInTimeZone(date, timezone, "yyyy-MM-dd HH:mm:ss");
+  return new Date(formattedDate);
+}
diff --git a/src/user/index.ts b/src/user/index.ts
@@ -0,0 +1,17 @@
+export { UserClientAdapter } from "./adapters/primary/userClientAdapter";
+export { UserApiAdapter } from "./adapters/secondary/userApiAdapter";
+export { GetUserRequestDto } from "./application/dtos/request.dtos";
+export {
+  GetUserResponseDto,
+  GetChinguMemberStatusResponseDto,
+} from "./application/dtos/response.dto";
+export {
+  User,
+  VoyageTeamMember,
+  VoyageRole,
+  VoyageStatus,
+} from "./application/types/index";
+export { GetChinguMemberStatusUsecase } from "./application/usecases/getChinguMemberStatusUsecase";
+export { GetUserUsecase } from "./application/usecases/getUserUsecase";
+export { UserClientPort } from "./ports/primary/userClientPort";
+export { UserApiPort } from "./ports/secondary/userApiPort";
diff --git a/src/user/ports/primary/userClientPort.ts b/src/user/ports/primary/userClientPort.ts
@@ -0,0 +1,12 @@
+import type {
+  GetChinguMemberStatusResponseDto,
+  GetUserResponseDto,
+} from "@/user/application/dtos/response.dto";
+import { type GetUserRequestDto } from "@/user/application/dtos/request.dtos";
+
+export interface UserClientPort {
+  getUser: () => Promise<GetUserResponseDto>;
+  getChinguMemberStatus: (
+    user: GetUserRequestDto,
+  ) => GetChinguMemberStatusResponseDto;
+}
diff --git a/src/user/ports/secondary/userApiPort.ts b/src/user/ports/secondary/userApiPort.ts
@@ -0,0 +1,5 @@
+import { type GetUserResponseDto } from "@/user/application/dtos/response.dto";
+
+export interface UserApiPort {
+  getUser: () => Promise<GetUserResponseDto>;
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import type { User } from "@/user/application/types";`
	`2`	`+`
	`3`	`+export type GetUserRequestDto = User;`