Files
core/hwe/ts/util/callSammoAPI.ts
T

275 lines
9.6 KiB
TypeScript

import ky from "ky";
import { isArray, isEmpty } from "lodash-es";
export type ValidResponse = {
result: true;
};
export type APIRecoveryType = "login" | "2fa" | "gateway" | "game_login" | "game_quota";
export const APIRecoveryConst = {
Login: 'login',
TwoFactorAuth: '2fa',
Gateway: 'gateway',
GameLogin: 'game_login',
GameQuota: 'game_quota',
} as const;
export type InvalidResponse = {
result: false;
reason: string;
recovery?: APIRecoveryType;
recovery_arg?: string | number;
};
export type RawArgType = Record<string, unknown> | Record<string, unknown>[] | undefined;
interface BasicAPICallT<
ArgType extends RawArgType,
ResultType extends ValidResponse,
ErrorType extends InvalidResponse
> {
(args: ArgType): Promise<ResultType>;
(args: ArgType, returnError: false): Promise<ResultType>;
(args: ArgType, returnError: true): Promise<ResultType | ErrorType>;
}
interface EmptyAPICallT<ResultType extends ValidResponse, ErrorType extends InvalidResponse> {
(): Promise<ResultType>;
(args: undefined): Promise<ResultType>;
(args: undefined, returnError: false): Promise<ResultType>;
(args: undefined, returnError: true): Promise<ResultType | ErrorType>;
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export type ArgTypeOf<T> = T extends APICallT<infer A, any, any> ? A : never;
export type APICallT<
ArgType extends RawArgType,
ResultType extends ValidResponse = ValidResponse,
ErrorType extends InvalidResponse = InvalidResponse
> = ArgType extends undefined ? EmptyAPICallT<ResultType, ErrorType> : BasicAPICallT<ArgType, ResultType, ErrorType>;
type HttpMethod = "get" | "post" | "put" | "patch" | "head" | "delete";
export type APITail = typeof GET | typeof POST | typeof PUT | typeof PATCH | typeof HEAD | typeof DELETE;
const httpMethodMap = new Map<APITail, HttpMethod>([
[GET, "get"],
[POST, "post"],
[PUT, "put"],
[PATCH, "patch"],
[HEAD, "head"],
[DELETE, "delete"],
]);
export function extractHttpMethod(tail: APITail): HttpMethod {
return httpMethodMap.get(tail) ?? "post";
}
const apiTarget = "api.php";
let apiPath = apiTarget;
export function setSammoAPIPrefix(prefix: string) {
apiPath = `${prefix}/${apiTarget}`;
}
export async function callSammoAPI<ResultType extends ValidResponse>(
method: HttpMethod,
path: string | string[],
args: RawArgType,
paramArgs: Record<string, string | number> | undefined
): Promise<ResultType>;
export async function callSammoAPI<ResultType extends ValidResponse>(
method: HttpMethod,
path: string | string[],
args: RawArgType,
paramArgs: Record<string, string | number> | undefined,
returnError: false
): Promise<ResultType>;
export async function callSammoAPI<ResultType extends ValidResponse, ErrorType extends InvalidResponse>(
method: HttpMethod,
path: string | string[],
args: RawArgType,
paramArgs: Record<string, string | number> | undefined,
returnError: true
): Promise<ResultType | ErrorType>;
export async function callSammoAPI<ResultType extends ValidResponse, ErrorType extends InvalidResponse>(
method: HttpMethod,
path: string | string[],
args: RawArgType,
paramArgs: Record<string, string | number> | undefined,
returnError = false
): Promise<ResultType | ErrorType> {
if (isArray(path)) {
path = path.join("/");
}
if (args && isEmpty(args)) {
args = undefined;
}
const result = (await (() => {
if (method == "get") {
return ky(apiPath, {
searchParams: {
...paramArgs,
...(args as typeof paramArgs),
path,
},
method,
headers: {
"content-type": "application/json",
},
timeout: 30000,
retry: 0,
});
}
return ky(apiPath, {
searchParams: {
...paramArgs,
path,
},
method,
json: args,
headers: {
"content-type": "application/json",
},
timeout: 30000,
retry: 0,
});
})().json()) as ErrorType | ResultType;
if (!result.result) {
if (returnError) {
return result;
}
throw result.reason;
}
return result;
}
export async function GET<ResultType extends ValidResponse, ArgType extends undefined = undefined>(
args?: ArgType
): Promise<ResultType>;
export async function GET<ResultType extends ValidResponse, ArgType extends undefined = undefined>(
args: ArgType | undefined,
returnError: false
): Promise<ResultType>;
export async function GET<
ResultType extends ValidResponse,
ErrorType extends InvalidResponse,
ArgType extends undefined = undefined
>(args: ArgType | undefined, returnError: true): Promise<ResultType | ErrorType>;
export async function GET<
ResultType extends ValidResponse,
ErrorType extends InvalidResponse,
ArgType extends undefined = undefined
>(args?: ArgType, returnError = false): Promise<ResultType | ErrorType> {
console.error(`Can't directly call GET. ${args}, ${returnError}. Use auto-generated path API.`);
return callSammoAPI<ResultType, ErrorType>("get", [], args, undefined, true);
}
export async function POST<ResultType extends ValidResponse, ArgType extends RawArgType = RawArgType>(
args?: ArgType
): Promise<ResultType>;
export async function POST<ResultType extends ValidResponse, ArgType extends RawArgType = RawArgType>(
args: ArgType | undefined,
returnError: false
): Promise<ResultType>;
export async function POST<
ResultType extends ValidResponse,
ErrorType extends InvalidResponse,
ArgType extends RawArgType = RawArgType
>(args: ArgType | undefined, returnError: true): Promise<ResultType | ErrorType>;
export async function POST<
ResultType extends ValidResponse,
ErrorType extends InvalidResponse,
ArgType extends RawArgType = RawArgType
>(args?: ArgType, returnError = false): Promise<ResultType | ErrorType> {
console.error(`Can't directly call POST. ${args}, ${returnError}. Use auto-generated path API.`);
return callSammoAPI<ResultType, ErrorType>("post", [], args, undefined, true);
}
export async function PUT<ResultType extends ValidResponse, ArgType extends RawArgType = RawArgType>(
args?: ArgType
): Promise<ResultType>;
export async function PUT<ResultType extends ValidResponse, ArgType extends RawArgType = RawArgType>(
args: ArgType | undefined,
returnError: false
): Promise<ResultType>;
export async function PUT<
ResultType extends ValidResponse,
ErrorType extends InvalidResponse,
ArgType extends RawArgType = RawArgType
>(args: ArgType | undefined, returnError: true): Promise<ResultType | ErrorType>;
export async function PUT<
ResultType extends ValidResponse,
ErrorType extends InvalidResponse,
ArgType extends RawArgType = RawArgType
>(args?: ArgType, returnError = false): Promise<ResultType | ErrorType> {
console.error(`Can't directly call PUT. ${args}, ${returnError}. Use auto-generated path API.`);
return callSammoAPI<ResultType, ErrorType>("put", [], args, undefined, true);
}
export async function PATCH<ResultType extends ValidResponse, ArgType extends RawArgType = RawArgType>(
args?: ArgType
): Promise<ResultType>;
export async function PATCH<ResultType extends ValidResponse, ArgType extends RawArgType = RawArgType>(
args: ArgType | undefined,
returnError: false
): Promise<ResultType>;
export async function PATCH<
ResultType extends ValidResponse,
ErrorType extends InvalidResponse,
ArgType extends RawArgType = RawArgType
>(args: ArgType | undefined, returnError: true): Promise<ResultType | ErrorType>;
export async function PATCH<
ResultType extends ValidResponse,
ErrorType extends InvalidResponse,
ArgType extends RawArgType = RawArgType
>(args?: ArgType, returnError = false): Promise<ResultType | ErrorType> {
console.error(`Can't directly call PATCH. ${args}, ${returnError}. Use auto-generated path API.`);
return callSammoAPI<ResultType, ErrorType>("patch", [], args, undefined, true);
}
export async function HEAD<ResultType extends ValidResponse, ArgType extends undefined = undefined>(
args?: ArgType
): Promise<ResultType>;
export async function HEAD<ResultType extends ValidResponse, ArgType extends undefined = undefined>(
args: ArgType | undefined,
returnError: false
): Promise<ResultType>;
export async function HEAD<
ResultType extends ValidResponse,
ErrorType extends InvalidResponse,
ArgType extends undefined = undefined
>(args: ArgType | undefined, returnError: true): Promise<ResultType | ErrorType>;
export async function HEAD<
ResultType extends ValidResponse,
ErrorType extends InvalidResponse,
ArgType extends undefined = undefined
>(args?: ArgType, returnError = false): Promise<ResultType | ErrorType> {
console.error(`Can't directly call HEAD. ${args}, ${returnError}. Use auto-generated path API.`);
return callSammoAPI<ResultType, ErrorType>("head", [], args, undefined, true);
}
export async function DELETE<ResultType extends ValidResponse, ArgType extends RawArgType = RawArgType>(
args?: ArgType
): Promise<ResultType>;
export async function DELETE<ResultType extends ValidResponse, ArgType extends RawArgType = RawArgType>(
args: ArgType | undefined,
returnError: false
): Promise<ResultType>;
export async function DELETE<
ResultType extends ValidResponse,
ErrorType extends InvalidResponse,
ArgType extends RawArgType = RawArgType
>(args: ArgType | undefined, returnError: true): Promise<ResultType | ErrorType>;
export async function DELETE<
ResultType extends ValidResponse,
ErrorType extends InvalidResponse,
ArgType extends RawArgType = RawArgType
>(args?: ArgType, returnError = false): Promise<ResultType | ErrorType> {
console.error(`Can't directly call DELETE. ${args}, ${returnError}. Use auto-generated path API.`);
return callSammoAPI<ResultType, ErrorType>("patch", [], args, undefined, true);
}