devsam/core
3
6
Fork 1
Code Issues 60 Pull Requests Releases 1 Wiki Activity

feat: APICoveryType에 맞게 InvalidResponse 확장

Browse Source
This commit is contained in:
Hide_D
2022-08-18 01:08:38 +09:00
parent b0f3c1c97d
commit 9512ea9b52
1 changed files with 224 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files
hwe/ts/util/callSammoAPI.ts
+174 -61
View File
@@ -1,19 +1,33 @@
import ky from 'ky'; import ky from "ky";
import { isArray, isEmpty } from "lodash"; import { isArray, isEmpty } from "lodash";
export type ValidResponse = { export type ValidResponse = {
result: true 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 = { export type InvalidResponse = {
result: false; result: false;
reason: string; reason: string;
} recovery?: APIRecoveryType;
recovery_arg?: string | number;
};
export type RawArgType = Record<string, unknown> | Record<string, unknown>[] | undefined; export type RawArgType = Record<string, unknown> | Record<string, unknown>[] | undefined;
interface BasicAPICallT<ArgType extends RawArgType, ResultType extends ValidResponse, ErrorType extends InvalidResponse> { interface BasicAPICallT<
ArgType extends RawArgType,
ResultType extends ValidResponse,
ErrorType extends InvalidResponse
> {
(args: ArgType): Promise<ResultType>; (args: ArgType): Promise<ResultType>;
(args: ArgType, returnError: false): Promise<ResultType>; (args: ArgType, returnError: false): Promise<ResultType>;
(args: ArgType, returnError: true): Promise<ResultType | ErrorType>; (args: ArgType, returnError: true): Promise<ResultType | ErrorType>;
@@ -33,47 +47,68 @@ export type APICallT<
ArgType extends RawArgType, ArgType extends RawArgType,
ResultType extends ValidResponse = ValidResponse, ResultType extends ValidResponse = ValidResponse,
ErrorType extends InvalidResponse = InvalidResponse ErrorType extends InvalidResponse = InvalidResponse
> = ArgType extends undefined > = ArgType extends undefined ? EmptyAPICallT<ResultType, ErrorType> : BasicAPICallT<ArgType, ResultType, ErrorType>;
? EmptyAPICallT<ResultType, ErrorType>
: BasicAPICallT<ArgType, ResultType, ErrorType>;
type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'; type HttpMethod = "get" | "post" | "put" | "patch" | "head" | "delete";
export type APITail = typeof GET | typeof POST | typeof PUT | typeof PATCH | typeof HEAD | typeof DELETE; export type APITail = typeof GET | typeof POST | typeof PUT | typeof PATCH | typeof HEAD | typeof DELETE;
const httpMethodMap = new Map<APITail, HttpMethod>([ const httpMethodMap = new Map<APITail, HttpMethod>([
[GET, 'get'], [GET, "get"],
[POST, 'post'], [POST, "post"],
[PUT, 'put'], [PUT, "put"],
[PATCH, 'patch'], [PATCH, "patch"],
[HEAD, 'head'], [HEAD, "head"],
[DELETE, 'delete'], [DELETE, "delete"],
]); ]);
export function extractHttpMethod(tail: APITail): HttpMethod { export function extractHttpMethod(tail: APITail): HttpMethod {
return httpMethodMap.get(tail) ?? 'post'; return httpMethodMap.get(tail) ?? "post";
} }
const apiTarget = 'api.php'; const apiTarget = "api.php";
let apiPath = apiTarget; let apiPath = apiTarget;
export function setSammoAPIPrefix(prefix: string) { export function setSammoAPIPrefix(prefix: string) {
apiPath = `${prefix}/${apiTarget}`; 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>(
export async function callSammoAPI<ResultType extends ValidResponse>(method: HttpMethod, path: string | string[], args: RawArgType, paramArgs: Record<string, string | number> | undefined, returnError: false): Promise<ResultType>; method: HttpMethod,
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>; path: string | string[],
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> { 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)) { if (isArray(path)) {
path = path.join('/'); path = path.join("/");
} }
if (args && isEmpty(args)) { if (args && isEmpty(args)) {
args = undefined; args = undefined;
} }
const result = await (() => { const result = (await (() => {
if (method == 'get') { if (method == "get") {
return ky(apiPath, { return ky(apiPath, {
searchParams: { searchParams: {
...paramArgs, ...paramArgs,
@@ -82,11 +117,11 @@ export async function callSammoAPI<ResultType extends ValidResponse, ErrorType e
}, },
method, method,
headers: { headers: {
'content-type': 'application/json' "content-type": "application/json",
} },
}); });
} }
return ky('api.php', { return ky("api.php", {
searchParams: { searchParams: {
...paramArgs, ...paramArgs,
path, path,
@@ -94,10 +129,10 @@ export async function callSammoAPI<ResultType extends ValidResponse, ErrorType e
method, method,
json: args, json: args,
headers: { headers: {
'content-type': 'application/json' "content-type": "application/json",
} },
}); });
})().json() as ErrorType | ResultType; })().json()) as ErrorType | ResultType;
if (!result.result) { if (!result.result) {
if (returnError) { if (returnError) {
@@ -108,50 +143,128 @@ export async function callSammoAPI<ResultType extends ValidResponse, ErrorType e
return result; 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>(
export async function GET<ResultType extends ValidResponse, ArgType extends undefined = undefined>(args: ArgType | undefined, returnError: false): Promise<ResultType>; args?: ArgType
export async function GET<ResultType extends ValidResponse, ErrorType extends InvalidResponse, ArgType extends undefined = undefined>(args: ArgType | undefined, returnError: true): Promise<ResultType | ErrorType>; ): Promise<ResultType>;
export async function GET<ResultType extends ValidResponse, ErrorType extends InvalidResponse, ArgType extends undefined = undefined>(args?: ArgType, returnError = false): Promise<ResultType | ErrorType> { 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.`); console.error(`Can't directly call GET. ${args}, ${returnError}. Use auto-generated path API.`);
return callSammoAPI<ResultType, ErrorType>('get', [], args, undefined, true); 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>(
export async function POST<ResultType extends ValidResponse, ArgType extends RawArgType = RawArgType>(args: ArgType | undefined, returnError: false): Promise<ResultType>; args?: ArgType
export async function POST<ResultType extends ValidResponse, ErrorType extends InvalidResponse, ArgType extends RawArgType = RawArgType>(args: ArgType | undefined, returnError: true): Promise<ResultType | ErrorType>; ): Promise<ResultType>;
export async function POST<ResultType extends ValidResponse, ErrorType extends InvalidResponse, ArgType extends RawArgType = RawArgType>(args?: ArgType, returnError = false): Promise<ResultType | ErrorType> { 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.`); console.error(`Can't directly call POST. ${args}, ${returnError}. Use auto-generated path API.`);
return callSammoAPI<ResultType, ErrorType>('post', [], args, undefined, true); 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>(
export async function PUT<ResultType extends ValidResponse, ArgType extends RawArgType = RawArgType>(args: ArgType | undefined, returnError: false): Promise<ResultType>; args?: ArgType
export async function PUT<ResultType extends ValidResponse, ErrorType extends InvalidResponse, ArgType extends RawArgType = RawArgType>(args: ArgType | undefined, returnError: true): Promise<ResultType | ErrorType>; ): Promise<ResultType>;
export async function PUT<ResultType extends ValidResponse, ErrorType extends InvalidResponse, ArgType extends RawArgType = RawArgType>(args?: ArgType, returnError = false): Promise<ResultType | ErrorType> { 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.`); console.error(`Can't directly call PUT. ${args}, ${returnError}. Use auto-generated path API.`);
return callSammoAPI<ResultType, ErrorType>('put', [], args, undefined, true); 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>(
export async function PATCH<ResultType extends ValidResponse, ArgType extends RawArgType = RawArgType>(args: ArgType | undefined, returnError: false): Promise<ResultType>; args?: ArgType
export async function PATCH<ResultType extends ValidResponse, ErrorType extends InvalidResponse, ArgType extends RawArgType = RawArgType>(args: ArgType | undefined, returnError: true): Promise<ResultType | ErrorType>; ): Promise<ResultType>;
export async function PATCH<ResultType extends ValidResponse, ErrorType extends InvalidResponse, ArgType extends RawArgType = RawArgType>(args?: ArgType, returnError = false): Promise<ResultType | ErrorType> { 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.`); console.error(`Can't directly call PATCH. ${args}, ${returnError}. Use auto-generated path API.`);
return callSammoAPI<ResultType, ErrorType>('patch', [], args, undefined, true); 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>(
export async function HEAD<ResultType extends ValidResponse, ArgType extends undefined = undefined>(args: ArgType | undefined, returnError: false): Promise<ResultType>; args?: ArgType
export async function HEAD<ResultType extends ValidResponse, ErrorType extends InvalidResponse, ArgType extends undefined = undefined>(args: ArgType | undefined, returnError: true): Promise<ResultType | ErrorType>; ): Promise<ResultType>;
export async function HEAD<ResultType extends ValidResponse, ErrorType extends InvalidResponse, ArgType extends undefined = undefined>(args?: ArgType, returnError = false): Promise<ResultType | ErrorType> { 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.`); console.error(`Can't directly call HEAD. ${args}, ${returnError}. Use auto-generated path API.`);
return callSammoAPI<ResultType, ErrorType>('head', [], args, undefined, true); 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>(
export async function DELETE<ResultType extends ValidResponse, ArgType extends RawArgType = RawArgType>(args: ArgType | undefined, returnError: false): Promise<ResultType>; args?: ArgType
export async function DELETE<ResultType extends ValidResponse, ErrorType extends InvalidResponse, ArgType extends RawArgType = RawArgType>(args: ArgType | undefined, returnError: true): Promise<ResultType | ErrorType>; ): Promise<ResultType>;
export async function DELETE<ResultType extends ValidResponse, ErrorType extends InvalidResponse, ArgType extends RawArgType = RawArgType>(args?: ArgType, returnError = false): Promise<ResultType | ErrorType> { 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.`); console.error(`Can't directly call DELETE. ${args}, ${returnError}. Use auto-generated path API.`);
return callSammoAPI<ResultType, ErrorType>('patch', [], args, undefined, true); return callSammoAPI<ResultType, ErrorType>("patch", [], args, undefined, true);
} }