summaryrefslogtreecommitdiff
path: root/packages/backend/src/server/api/endpoint-base.ts
diff options
context:
space:
mode:
authorsyuilo <Syuilotan@yahoo.co.jp>2022-09-18 03:27:08 +0900
committerGitHub <noreply@github.com>2022-09-18 03:27:08 +0900
commitb75184ec8e3436200bacdcd832e3324702553d20 (patch)
tree8b7e316f29e95df921db57289c8b8da476d18f07 /packages/backend/src/server/api/endpoint-base.ts
parentUpdate ROADMAP.md (diff)
downloadsharkey-b75184ec8e3436200bacdcd832e3324702553d20.tar.gz
sharkey-b75184ec8e3436200bacdcd832e3324702553d20.tar.bz2
sharkey-b75184ec8e3436200bacdcd832e3324702553d20.zip
なんかもうめっちゃ変えた
Diffstat (limited to 'packages/backend/src/server/api/endpoint-base.ts')
-rw-r--r--packages/backend/src/server/api/endpoint-base.ts62
1 files changed, 62 insertions, 0 deletions
diff --git a/packages/backend/src/server/api/endpoint-base.ts b/packages/backend/src/server/api/endpoint-base.ts
new file mode 100644
index 0000000000..0a7f9b3008
--- /dev/null
+++ b/packages/backend/src/server/api/endpoint-base.ts
@@ -0,0 +1,62 @@
+import * as fs from 'node:fs';
+import Ajv from 'ajv';
+import type { Schema, SchemaType } from '@/misc/schema.js';
+import type { CacheableLocalUser } from '@/models/entities/User.js';
+import type { AccessToken } from '@/models/entities/AccessToken.js';
+import { ApiError } from './error.js';
+import type { IEndpointMeta } from './endpoints.js';
+
+const ajv = new Ajv({
+ useDefaults: true,
+});
+
+ajv.addFormat('misskey:id', /^[a-zA-Z0-9]+$/);
+
+export type Response = Record<string, any> | void;
+
+// TODO: paramsの型をT['params']のスキーマ定義から推論する
+type executor<T extends IEndpointMeta, Ps extends Schema> =
+ (params: SchemaType<Ps>, user: T['requireCredential'] extends true ? CacheableLocalUser : CacheableLocalUser | null, token: AccessToken | null, file?: any, cleanup?: () => any, ip?: string | null, headers?: Record<string, string> | null) =>
+ Promise<T['res'] extends undefined ? Response : SchemaType<NonNullable<T['res']>>>;
+
+export abstract class Endpoint<T extends IEndpointMeta, Ps extends Schema> {
+ public exec: (params: any, user: T['requireCredential'] extends true ? CacheableLocalUser : CacheableLocalUser | null, token: AccessToken | null, file?: any, ip?: string | null, headers?: Record<string, string> | null) => Promise<any>;
+
+ constructor(meta: T, paramDef: Ps, cb: executor<T, Ps>) {
+ const validate = ajv.compile(paramDef);
+
+ this.exec = (params: any, user: T['requireCredential'] extends true ? CacheableLocalUser : CacheableLocalUser | null, token: AccessToken | null, file?: any, ip?: string | null, headers?: Record<string, string> | null) => {
+ let cleanup: undefined | (() => void) = undefined;
+
+ if (meta.requireFile) {
+ cleanup = () => {
+ fs.unlink(file.path, () => {});
+ };
+
+ 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);
+ };
+ }
+}