1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
/*
Spacebar: A FOSS re-implementation and extension of the Discord.com backend.
Copyright (C) 2023 Spacebar and Spacebar Contributors
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import {
DiscordApiErrors,
EVENT,
FieldErrors,
PermissionResolvable,
Permissions,
RightResolvable,
Rights,
SpacebarApiErrors,
ajv,
getPermission,
getRights,
normalizeBody,
} from "@spacebar/util";
import { AnyValidateFunction } from "ajv/dist/core";
import { NextFunction, Request, Response } from "express";
declare global {
// TODO: fix this
// eslint-disable-next-line @typescript-eslint/no-namespace
namespace Express {
interface Request {
permission?: Permissions;
}
}
}
export type RouteResponse = {
status?: number;
body?: `${string}Response`;
headers?: Record<string, string>;
};
export interface RouteOptions {
permission?: PermissionResolvable;
right?: RightResolvable;
requestBody?: `${string}Schema`; // typescript interface name
responses?: {
[status: number]: {
// body?: `${string}Response`;
body?: string;
};
};
event?: EVENT | EVENT[];
summary?: string;
description?: string;
query?: {
[key: string]: {
type: string;
required?: boolean;
description?: string;
values?: string[];
};
};
deprecated?: boolean;
// test?: {
// response?: RouteResponse;
// body?: unknown;
// path?: string;
// event?: EVENT | EVENT[];
// headers?: Record<string, string>;
// };
}
export function route(opts: RouteOptions) {
let validate: AnyValidateFunction | undefined;
if (opts.requestBody) {
validate = ajv.getSchema(opts.requestBody);
if (!validate)
throw new Error(`Body schema ${opts.requestBody} not found`);
}
return async (req: Request, res: Response, next: NextFunction) => {
if (opts.permission) {
const required = new Permissions(opts.permission);
req.permission = await getPermission(
req.user_id,
req.params.guild_id,
req.params.channel_id,
);
// bitfield comparison: check if user lacks certain permission
if (!req.permission.has(required)) {
throw DiscordApiErrors.MISSING_PERMISSIONS.withParams(
opts.permission as string,
);
}
}
if (opts.right) {
const required = new Rights(opts.right);
req.rights = await getRights(req.user_id);
if (!req.rights || !req.rights.has(required)) {
throw SpacebarApiErrors.MISSING_RIGHTS.withParams(
opts.right as string,
);
}
}
if (validate) {
const valid = validate(normalizeBody(req.body));
if (!valid) {
const fields: Record<
string,
{ code?: string; message: string }
> = {};
validate.errors?.forEach(
(x) =>
(fields[x.instancePath.slice(1)] = {
code: x.keyword,
message: x.message || "",
}),
);
throw FieldErrors(fields);
}
}
next();
};
}
|
