Task/port over existing repos

.changeset/funny-games-dance.md

@@ -0,0 +1,5 @@
+---
+"motidata": minor
+---
+
+Ported over GroupRepository

.changeset/wild-rats-attack.md

@@ -0,0 +1,6 @@
+---
+"motidata": major
+---
+
+Repository methods read json-data themselves and return it as part of the `SimpleResponseDTO` return value.
+Remove calls to `Response.json` and instead handle the new return Type `SimpleResponseDTO`.

package.json

@@ -29,6 +29,7 @@
         "watch": "vitest",
         "test": "vitest run",
         "ci": "npm run lint && npm run check-format && npm run test && npm run check-exports && npm run build",
+        "changeset": "changeset",
         "local-release": "changeset version && changeset publish",
         "release": "changeset publish",
         "prepublishOnly": "npm run ci"

src/DTOs/GroupDetailsDTO.ts

@@ -0,0 +1,7 @@
+import type { GroupMemberProfileDTO } from "./GroupMemberDTO.js";
+
+export interface GroupDetailsDTO {
+    groupName: string;
+    members: GroupMemberProfileDTO[];
+    inviteCode: string;
+}

src/DTOs/GroupMemberDTO.ts

@@ -0,0 +1,5 @@
+export interface GroupMemberProfileDTO {
+    userId: string;
+    username: string;
+    profileImageUri: string;
+}

src/DTOs/GroupMessageDTO.ts

@@ -0,0 +1,14 @@
+export interface BaseGroupMessageDTO {
+    timestamp: string;
+    content: string;
+    //TODO: Research which Image Types are returned by Expo and Browser Camera, e.g. Blob or a Stream;
+    type: "TEXT" | "IMAGE";
+    isMotiMateMessage: boolean;
+}
+
+export interface GroupMessageDTO extends BaseGroupMessageDTO {
+    messageId: string;
+    authorId: string | null;
+    content: string;
+    clapCount: number;
+}

src/DTOs/RegistrationDTO.ts

@@ -0,0 +1,15 @@
+export interface RegistrationDTO {
+    username: string;
+    email: string;
+    password: string;
+}
+
+export const RegistrationHelper = {
+    buildFromObject({
+        username = "",
+        email = "",
+        password = "",
+    }: RegistrationDTO) {
+        return { username, email, password };
+    },
+};

src/DTOs/SimpleResponseDTO.ts

@@ -0,0 +1,46 @@
+import type { Serializable } from "child_process";
+
+export interface SimpleResponseDTO<
+    BodyType extends Serializable | undefined = undefined,
+> {
+    ok: boolean;
+    statusCode: number;
+    data?: BodyType;
+}
+
+/**
+ * Collection of {@link SimpleResponseDTO} Helpers
+ */
+export const SimpleResponseHelpers = {
+    /**
+     * Due to limitations of NextJs Server Actions, [this can not be  a class](https://react.dev/reference/rsc/use-server#serializable-parameters-and-return-values).
+     * @throws any `Response.json()` related error
+     */
+    async transformToSimpleResponse<
+        ResponseDTO extends Serializable | undefined = undefined,
+    >(fetchResponse: Response): Promise<SimpleResponseDTO<ResponseDTO>> {
+        return {
+            ok: fetchResponse.ok,
+            statusCode: fetchResponse.status,
+            data: (await this._extractDataBasedOnContentType(
+                fetchResponse,
+            )) as ResponseDTO,
+        };
+    },
+
+    /**
+     * @private
+     */
+    async _extractDataBasedOnContentType(
+        fetchResponse: Response,
+    ): Promise<unknown> {
+        const CONTENT_TYPE = fetchResponse.headers.get("Content-Type");
+        if (CONTENT_TYPE === null) {
+            return undefined;
+        } else if (CONTENT_TYPE.includes("application/json")) {
+            return await fetchResponse.json();
+        } else if (CONTENT_TYPE.includes("text/plain")) {
+            return await fetchResponse.text();
+        }
+    },
+};

src/DTOs/UserDetailsDTO.ts

@@ -0,0 +1,8 @@
+import type { GroupDetailsDTO } from "./GroupDetailsDTO.js";
+
+export interface UserDetailsDTO {
+    userId: string;
+    personalGoal: number;
+    personalProgress: number;
+    groupInfo: GroupDetailsDTO;
+}

src/DTOs/__tests__/SimpleResponseDTO.test.ts

@@ -0,0 +1,57 @@
+import { expect, test } from "vitest";
+import {
+    SimpleResponseHelpers,
+    type SimpleResponseDTO,
+} from "../SimpleResponseDTO.js";
+
+test("should transform to SimpleResponseDTO", async () => {
+    //GIVEN
+    const EXPECTED_STATUS = 200;
+    const EXPECTED_DATA = { aKey: "aValue" };
+    const RESPONSE = new Response(JSON.stringify(EXPECTED_DATA), {
+        status: EXPECTED_STATUS,
+        headers: new Headers({ "Content-Type": "application/json" }),
+    });
+
+    //WHEN
+    const ACTUAL =
+        await SimpleResponseHelpers.transformToSimpleResponse<
+            typeof EXPECTED_DATA
+        >(RESPONSE);
+
+    //THEN
+    expect(ACTUAL).toEqual<SimpleResponseDTO<typeof EXPECTED_DATA>>({
+        ok: RESPONSE.ok,
+        statusCode: RESPONSE.status,
+        data: EXPECTED_DATA,
+    });
+});
+
+test("should handle default, non json response", async () => {
+    //GIVEN
+    const EXPECTED_DATA = "12345";
+    const RESPONSE = new Response(EXPECTED_DATA);
+    //WHEN
+    const ACTUAL =
+        await SimpleResponseHelpers._extractDataBasedOnContentType(RESPONSE);
+
+    //THEN
+    expect(ACTUAL).toEqual(EXPECTED_DATA);
+});
+
+test("should handle Content-Type=application/json response", async () => {
+    //GIVEN
+    const EXPECTED_DATA = { testKey: "testValue" };
+    const RESPONSE = new Response(JSON.stringify(EXPECTED_DATA), {
+        headers: new Headers({
+            "Content-Type": "application/json; charset=utf-8",
+        }),
+    });
+
+    //WHEN
+    const ACTUAL =
+        await SimpleResponseHelpers._extractDataBasedOnContentType(RESPONSE);
+
+    //THEN
+    expect(ACTUAL).toEqual(EXPECTED_DATA);
+});

src/constants/ContentTypeHeader.ts

@@ -0,0 +1,5 @@
+export const ContentType = "Content-Type";
+export const MimeTypes = {
+    textPlain: "text/plain",
+    applicationJson: "application/json",
+};

src/index.ts

@@ -1,2 +1,19 @@
-export { UserRepository } from "./repositories/UserRepository.js";
+// Repositories:
 export type { SessionRepositoryInterface } from "./repositories/SessionRepositoryInterface.ts";
+export { UserRepository } from "./repositories/UserRepository.js";
+export { GroupRepository } from "./repositories/GroupRepository.js";
+//DTOs:
+export type { SimpleResponseDTO as SimpleResponse } from "./DTOs/SimpleResponseDTO.ts";
+export type { RegistrationDTO } from "./DTOs/RegistrationDTO.ts";
+export type { UserDetailsDTO } from "./DTOs/UserDetailsDTO.ts";
+export type { GroupDetailsDTO } from "./DTOs/GroupDetailsDTO.ts";
+export type { GroupMemberProfileDTO } from "./DTOs/GroupMemberDTO.ts";
+export type {
+    GroupMessageDTO,
+    BaseGroupMessageDTO,
+} from "./DTOs/GroupMessageDTO.ts";
+//DTO-Helpers:
+export { SimpleResponseHelpers } from "./DTOs/SimpleResponseDTO.js";
+export { RegistrationHelper } from "./DTOs/RegistrationDTO.js";
+// Miscellanieous Types:
+export type { BaseRepositoryConstructorParam } from "./repositories/BaseRepository.ts";

src/repositories/BaseRepository.ts

@@ -1,15 +1,26 @@
+import type { Serializable } from "child_process";
+import { ContentType, MimeTypes } from "../constants/ContentTypeHeader.js";
 import { CustomHeadersNames } from "../constants/CustomHeaders.js";
 import type { SessionRepositoryInterface } from "./SessionRepositoryInterface.js";
 
 type ApiBaseUrlType =
     (typeof BaseRepository.Api)[keyof typeof BaseRepository.Api];
 
-export interface BaseRepositoryConstructorArgs {
+export interface BaseRepositoryConstructorParam {
     apiBaseUrl: ApiBaseUrlType;
     publicApiKey: string;
     sessionRepository: SessionRepositoryInterface;
 }
 
+interface RequestParams {
+    route: string;
+    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    queryParams?: URLSearchParams;
+    extraHeaders?: Headers;
+    body?: RequestInit["body"];
+    signal?: AbortSignal | null;
+}
+
 export abstract class BaseRepository {
     static Api = { mockaroo: "https://my.api.mockaroo.com" };
 
@@ -28,20 +39,24 @@ export abstract class BaseRepository {
         public sessionRepository: SessionRepositoryInterface,
     ) {}
 
+    /**
+     * @throws any {@link sessionRepository} related Error
+     */
     private async buildBaseHeaders() {
-        const HEADERS = new Headers();
-        HEADERS.append(
-            CustomHeadersNames.sessionId,
-            await this.sessionRepository.readSessionId(),
-        );
-
-        HEADERS.append(CustomHeadersNames.apiKey, this.publicApiKey);
+        const HEADERS = new Headers({
+            [CustomHeadersNames.sessionId]:
+                await this.sessionRepository.readSessionId(),
+            [CustomHeadersNames.apiKey]: this.publicApiKey,
+            [ContentType]: MimeTypes.applicationJson,
+        });
 
         return HEADERS;
     }
 
     /**
+     * Sets the Content-Type to application/json by default. Can be overridden by settin {@link extraHeaders}.
      * @protected
+     * @throws any {@link sessionRepository} related Error
      */
     async _bulildRequest({
         route,
@@ -50,14 +65,7 @@ export abstract class BaseRepository {
         extraHeaders = new Headers(),
         body,
         signal,
-    }: {
-        route: string;
-        method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
-        queryParams?: URLSearchParams;
-        extraHeaders?: Headers;
-        body?: RequestInit["body"];
-        signal?: AbortSignal | null;
-    }): Promise<Request> {
+    }: RequestParams): Promise<Request> {
         const headers = await this.buildBaseHeaders();
         extraHeaders.forEach((headerValue, headerName) => {
             headers.append(headerName, headerValue);
@@ -77,6 +85,20 @@ export abstract class BaseRepository {
     /**
      * @protected
      */
+    async _buildJsonRequest(
+        unserializedBody: Serializable,
+        requestParams: Omit<RequestParams, "body">,
+    ): Promise<Request> {
+        return this._bulildRequest({
+            ...requestParams,
+            body: JSON.stringify(unserializedBody),
+        });
+    }
+
+    /**
+     * @protected
+     * @throws any {@link sessionRepository} related Error
+     */
     async _handleResponseAfterAuthentication(
         response: Response,
     ): Promise<void> {