Sharkey/packages/backend/src/server/api/endpoint-base.ts

70 lines
2.4 KiB
TypeScript
Raw Normal View History

2022-09-17 21:27:08 +03:00
import * as fs from 'node:fs';
import _Ajv from 'ajv';
2023-03-10 07:22:37 +02:00
import type { Schema, SchemaType } from '@/misc/json-schema.js';
2023-02-13 08:50:22 +02:00
import type { LocalUser } from '@/models/entities/User.js';
2022-09-17 21:27:08 +03:00
import type { AccessToken } from '@/models/entities/AccessToken.js';
import { ApiError } from './error.js';
import type { IEndpointMeta } from './endpoints.js';
const Ajv = _Ajv.default;
2022-09-17 21:27:08 +03:00
const ajv = new Ajv({
useDefaults: true,
});
ajv.addFormat('misskey:id', /^[a-zA-Z0-9]+$/);
export type Response = Record<string, any> | void;
type File = {
name: string | null;
path: string;
};
2022-09-17 21:27:08 +03:00
// TODO: paramsの型をT['params']のスキーマ定義から推論する
type Executor<T extends IEndpointMeta, Ps extends Schema> =
2023-02-13 08:50:22 +02:00
(params: SchemaType<Ps>, user: T['requireCredential'] extends true ? LocalUser : LocalUser | null, token: AccessToken | null, file?: File, cleanup?: () => any, ip?: string | null, headers?: Record<string, string> | null) =>
2022-09-17 21:27:08 +03:00
Promise<T['res'] extends undefined ? Response : SchemaType<NonNullable<T['res']>>>;
export abstract class Endpoint<T extends IEndpointMeta, Ps extends Schema> {
2023-02-13 08:50:22 +02:00
public exec: (params: any, user: T['requireCredential'] extends true ? LocalUser : LocalUser | null, token: AccessToken | null, file?: File, ip?: string | null, headers?: Record<string, string> | null) => Promise<any>;
2022-09-17 21:27:08 +03:00
constructor(meta: T, paramDef: Ps, cb: Executor<T, Ps>) {
2022-09-17 21:27:08 +03:00
const validate = ajv.compile(paramDef);
2023-02-13 08:50:22 +02:00
this.exec = (params: any, user: T['requireCredential'] extends true ? LocalUser : LocalUser | null, token: AccessToken | null, file?: File, ip?: string | null, headers?: Record<string, string> | null) => {
2022-09-17 21:27:08 +03:00
let cleanup: undefined | (() => void) = undefined;
if (meta.requireFile) {
cleanup = () => {
if (file) fs.unlink(file.path, () => {});
2022-09-17 21:27:08 +03:00
};
if (file == null) return Promise.reject(new ApiError({
message: 'File required.',
code: 'FILE_REQUIRED',
id: '4267801e-70d1-416a-b011-4ee502885d8b',
}));
}
const valid = validate(params);
if (!valid) {
if (file) cleanup!();
const errors = validate.errors!;
const err = new ApiError({
message: 'Invalid param.',
code: 'INVALID_PARAM',
id: '3d81ceae-475f-4600-b2a8-2bc116157532',
}, {
param: errors[0].schemaPath,
reason: errors[0].message,
});
return Promise.reject(err);
}
return cb(params as SchemaType<Ps>, user, token, file, cleanup, ip, headers);
};
}
}