jormungandr-bite/packages/backend/src/server/api/endpoints/username/available.ts
Namekuji dda66daedd feat: reserved usernames ()
This PR adds a feature to prevent users from creating a new account with a reserved username such as root, admin, system, proxy, info, etc...

Reserved usernames can be configured via the config file.

The administrator can create an account with a reserved username via the first setup screen or the control panel.

The existing account of reserved usernames will not be affected.

Co-authored-by: Namekuji <nmkj@mx.kazuno.co>
Reviewed-on: https://codeberg.org/calckey/calckey/pulls/9917
Co-authored-by: Namekuji <nmkj@noreply.codeberg.org>
Co-committed-by: Namekuji <nmkj@noreply.codeberg.org>
2023-04-26 20:06:18 +00:00

51 lines
991 B
TypeScript

import { IsNull } from "typeorm";
import { Users, UsedUsernames } from "@/models/index.js";
import config from "@/config/index.js";
import define from "../../define.js";
export const meta = {
tags: ["users"],
requireCredential: false,
res: {
type: "object",
optional: false,
nullable: false,
properties: {
available: {
type: "boolean",
optional: false,
nullable: false,
},
},
},
} as const;
export const paramDef = {
type: "object",
properties: {
username: Users.localUsernameSchema,
},
required: ["username"],
} as const;
export default define(meta, paramDef, async (ps) => {
// Get exist
const exist = await Users.countBy({
host: IsNull(),
usernameLower: ps.username.toLowerCase(),
});
const exist2 = await UsedUsernames.countBy({
username: ps.username.toLowerCase(),
});
const reserved = config.reservedUsernames?.includes(
ps.username.toLowerCase(),
);
return {
available: exist === 0 && exist2 === 0 && !reserved,
};
});