ffffng/frontend/src/utils/Api.ts

import {
    hasOwnProperty,
    isPlainObject,
    isString,
    type JSONValue,
    SortDirection,
    toIsArray,
    type TypeGuard,
} from "@/types";
import type { Headers } from "request";
import { parseToInteger } from "@/utils/Numbers";

type Method = "GET" | "POST" | "PUT" | "DELETE";

enum Header {
    CONTENT_TYPE = "Content-Type",
    "X_TOTAL_COUNT" = "x-total-count",
}

enum MimeType {
    APPLICATION_JSON = "application/json",
}

enum ApiErrorType {
    REQUEST_FAILED = "request_failed",
    UNEXPECTED_RESULT_TYPE = "unexpected_result_type",
}

enum HttpStatusCode {
    NOT_FOUND = 404,
    CONFLICT = 409,
}

export class ApiError extends Error {
    private constructor(
        message: string,
        private status: number,
        private errorType: ApiErrorType,
        private body: JSONValue
    ) {
        super(message);
    }

    static async requestFailed(
        method: Method,
        path: string,
        response: Response
    ): Promise<ApiError> {
        const body: JSONValue =
            response.headers.get(Header.CONTENT_TYPE) ===
            MimeType.APPLICATION_JSON
                ? await response.json()
                : await response.text();

        return new ApiError(
            `API ${method} request failed: ${path} => ${response.status} - ${body}`,
            response.status,
            ApiErrorType.REQUEST_FAILED,
            body
        );
    }

    static async unexpectedResultType(
        method: Method,
        path: string,
        response: Response,
        json: JSONValue
    ): Promise<ApiError> {
        return new ApiError(
            `API ${method} request result has unexpected type. ${path} => ${json}`,
            response.status,
            ApiErrorType.UNEXPECTED_RESULT_TYPE,
            json
        );
    }

    isNotFoundError(): boolean {
        return (
            this.errorType === ApiErrorType.REQUEST_FAILED &&
            this.status === HttpStatusCode.NOT_FOUND
        );
    }

    isConflict(): boolean {
        return (
            this.errorType === ApiErrorType.REQUEST_FAILED &&
            this.status === HttpStatusCode.CONFLICT
        );
    }

    getConflictField(): string | undefined {
        if (
            !this.isConflict() ||
            !isPlainObject(this.body) ||
            !hasOwnProperty(this.body, "field") ||
            !isString(this.body.field)
        ) {
            return undefined;
        }

        return this.body.field;
    }
}

interface PagedListResult<T> {
    entries: T[];
    total: number;
}

interface ApiResponse<T> {
    result: T;
    headers: Headers;
}

class Api {
    private baseURL: string = import.meta.env.BASE_URL;
    private apiPrefix = "api/";

    constructor(apiPrefix?: string) {
        if (apiPrefix) {
            this.apiPrefix = apiPrefix;
        }
    }

    private toURL(path: string, queryParams?: object): string {
        let queryString = "";
        if (queryParams) {
            const queryStrings: string[] = [];
            for (const [key, value] of Object.entries(queryParams)) {
                queryStrings.push(
                    `${encodeURIComponent(key)}=${encodeURIComponent(value)}`
                );
            }
            if (queryStrings.length > 0) {
                queryString = `?${queryStrings.join("&")}`;
            }
        }
        return this.baseURL + this.apiPrefix + path + queryString;
    }

    private async sendRequest<T>(
        method: Method,
        path: string,
        isT?: TypeGuard<T>,
        bodyData?: object,
        queryParams?: object
    ): Promise<ApiResponse<T>> {
        const url = this.toURL(path, queryParams);
        const options: RequestInit = {
            method,
        };
        if (bodyData) {
            options.body = JSON.stringify(bodyData);
            options.headers = {
                [Header.CONTENT_TYPE]: MimeType.APPLICATION_JSON,
            };
        }
        const response = await fetch(url, options);

        if (!response.ok) {
            throw await ApiError.requestFailed(method, path, response);
        }

        if (isT) {
            const json: JSONValue = await response.json();
            if (!isT(json)) {
                console.log(json);
                throw await ApiError.unexpectedResultType(
                    method,
                    path,
                    response,
                    json
                );
            }

            return {
                result: json,
                headers: response.headers,
            };
        } else {
            return {
                result: undefined as unknown as T,
                headers: response.headers,
            };
        }
    }

    async post<T>(
        path: string,
        isT: TypeGuard<T>,
        postData: object,
        queryParams?: object
    ): Promise<T> {
        const response = await this.sendRequest<T>(
            "POST",
            path,
            isT,
            postData,
            queryParams
        );
        return response.result;
    }

    async put<T>(
        path: string,
        isT: TypeGuard<T>,
        putData: object,
        queryParams?: object
    ): Promise<T> {
        const response = await this.sendRequest<T>(
            "PUT",
            path,
            isT,
            putData,
            queryParams
        );
        return response.result;
    }

    private async doGet<T>(
        path: string,
        isT: TypeGuard<T>,
        queryParams?: object
    ): Promise<ApiResponse<T>> {
        return await this.sendRequest<T>(
            "GET",
            path,
            isT,
            undefined,
            queryParams
        );
    }

    async get<T>(
        path: string,
        isT: TypeGuard<T>,
        queryParams?: object
    ): Promise<T> {
        const response = await this.doGet(path, isT, queryParams);
        return response.result;
    }

    async getPagedList<Element, SortField>(
        path: string,
        isElement: TypeGuard<Element>,
        page: number,
        itemsPerPage: number,
        sortDirection?: SortDirection,
        sortField?: SortField,
        filter?: object
    ): Promise<PagedListResult<Element>> {
        const response = await this.doGet(path, toIsArray(isElement), {
            _page: page,
            _perPage: itemsPerPage,
            _sortDir: sortDirection,
            _sortField: sortField,
            ...filter,
        });
        const totalStr = response.headers.get(Header.X_TOTAL_COUNT);
        const total = parseToInteger(totalStr, 10);

        return {
            entries: response.result,
            total,
        };
    }

    async delete(path: string): Promise<void> {
        await this.sendRequest("DELETE", path);
    }
}

export const api = new Api();

class InternalApi extends Api {
    constructor() {
        super("internal/api/");
    }
}

export const internalApi = new InternalApi();