/* eslint-disable @typescript-eslint/explicit-module-boundary-types */ /* eslint-disable @typescript-eslint/no-explicit-any */ import { isNumber, isString, isPlainObject, isError } from '../internal/base' import type { EmptyInterface } from '../@types' export interface ResponseCode { code: number codeMessage: string } export enum ResponseStatus { Success = 'success', Fail = 'fail', Error = 'error', Unknown = 'unknown' } export interface ErrorResponseData extends EmptyInterface { error?: E } export interface BaseResponse extends ResponseCode { status: ResponseStatus statusMessage: string data: D } export interface SuccessResponse extends BaseResponse { status: ResponseStatus.Success } export interface FailResponse extends BaseResponse { status: ResponseStatus.Fail } export interface ErrorResponse extends BaseResponse { status: ResponseStatus.Error } export interface UnknownResponse extends BaseResponse { status: ResponseStatus.Unknown } export type ResponseUnion< SD extends EmptyInterface = EmptyInterface, FD extends EmptyInterface = EmptyInterface, ED extends ErrorResponseData = ErrorResponseData > = SuccessResponse | FailResponse | ErrorResponse | UnknownResponse interface StatusSpecifiedResponse extends Omit, 'status'> { } type PartialStatusSpecifiedResponse = Partial> const DEFAULT_STATUS_MESSAGE = '' export const DEFAULT_SUCCESS_RESPONSE_CODE: ResponseCode = { code: 0, codeMessage: 'SUCCESS' } export const DEFAULT_FAIL_RESPONSE_CODE: ResponseCode = { code: 1, codeMessage: 'FAIL' } export const DEFAULT_ERROR_RESPONSE_CODE: ResponseCode = { code: 2, codeMessage: 'UNDEFINED_RUNTIME_ERROR' } export const DEFAULT_UNKNOWN_RESPONSE_CODE: ResponseCode = { code: 3, codeMessage: 'UNKNOWN_RESPONSE' } const DEFAULT_DATA: EmptyInterface = { } /** * Predicate whether the target is type of ResponseCode. */ export const isResponseCode = (tar: any): tar is ResponseCode => isPlainObject(tar) && isNumber(tar.code) && isString(tar.codeMessage) /** * @see {@link isResponseLike} */ export const isResponse = < SD extends EmptyInterface = EmptyInterface, FD extends EmptyInterface = EmptyInterface, ED extends ErrorResponseData = ErrorResponseData >(tar: any): tar is ResponseUnion => isPlainObject(tar) && Object.values(ResponseStatus).includes(tar.status) && isString(tar.statusMessage) && isPlainObject(tar.data) /** * @see {@link isResponse} */ export const isResponseLike = (tar: any): boolean => isPlainObject(tar) && isString(tar.status) && isString(tar.statusMessage) && isPlainObject(tar.data) export const isSuccessResponse = (tar: any): tar is SuccessResponse => isResponse(tar) && tar.status === ResponseStatus.Success export const isFailResponse = (tar: any): tar is FailResponse => isResponse(tar) && tar.status === ResponseStatus.Fail export const isErrorResponse = (tar: any): tar is ErrorResponse => isResponse(tar) && tar.status === ResponseStatus.Error export const isUnknowResponse = (tar: any): tar is UnknownResponse => isResponse(tar) && tar.status === ResponseStatus.Unknown export const makeSuccessResponse = ( { statusMessage, code, codeMessage, data }: PartialStatusSpecifiedResponse ): SuccessResponse => ({ status: ResponseStatus.Success, statusMessage: statusMessage ?? DEFAULT_STATUS_MESSAGE, code: code ?? DEFAULT_SUCCESS_RESPONSE_CODE.code, codeMessage: codeMessage ?? DEFAULT_SUCCESS_RESPONSE_CODE.codeMessage, data: data ?? DEFAULT_DATA as D }) export const makeFailResponse = ( { statusMessage, code, codeMessage, data }: PartialStatusSpecifiedResponse ): FailResponse => ({ status: ResponseStatus.Fail, statusMessage: statusMessage ?? DEFAULT_STATUS_MESSAGE, code: code ?? DEFAULT_FAIL_RESPONSE_CODE.code, codeMessage: codeMessage ?? DEFAULT_FAIL_RESPONSE_CODE.codeMessage, data: data ?? DEFAULT_DATA as D }) export const makeErrorResponse = ( { statusMessage, code, codeMessage, data }: PartialStatusSpecifiedResponse ): ErrorResponse => ({ status: ResponseStatus.Error, statusMessage: statusMessage ?? DEFAULT_STATUS_MESSAGE, code: code ?? DEFAULT_ERROR_RESPONSE_CODE.code, codeMessage: codeMessage ?? DEFAULT_ERROR_RESPONSE_CODE.codeMessage, data: data ?? DEFAULT_DATA as D }) export const makeUnknownResponse = ( { statusMessage, code, codeMessage, data }: PartialStatusSpecifiedResponse ): UnknownResponse => { console.warn(`[MobiusUtils][data] makeUnknownResponse: unknown response detected, ${JSON.stringify({ code, codeMessage, statusMessage, data })}`) return { status: ResponseStatus.Unknown, statusMessage: statusMessage ?? DEFAULT_STATUS_MESSAGE, code: code ?? DEFAULT_UNKNOWN_RESPONSE_CODE.code, codeMessage: codeMessage ?? DEFAULT_UNKNOWN_RESPONSE_CODE.codeMessage, data: data ?? DEFAULT_DATA as D } } export const dataToResponse = (data: D): SuccessResponse => { if (!isPlainObject(data)) { throw (new TypeError('"data" is expected to be type of "PlainObject".')) } return makeSuccessResponse({ data }) } export const errorToResponse = (error: E): ErrorResponse> => { const response = makeErrorResponse>({}) if (!isError(error)) { throw (new TypeError('"error" is expected to be type of "Error".')) } response.statusMessage = error.message response.data.error = error return response }