@directus/api
Version:
Directus is a real-time API and App dashboard for managing SQL database content
281 lines (279 loc) • 11.2 kB
JavaScript
import async_handler_default from "../utils/async-handler.js";
import { DEFAULT_AUTH_PROVIDER } from "../constants.js";
import { getDatabase } from "../database/index.js";
import { UsersService } from "../services/users.js";
import { respond } from "../middleware/respond.js";
import { TFAService } from "../services/tfa.js";
import { AuthenticationService } from "../services/authentication.js";
import { sanitizeQuery } from "../utils/sanitize-query.js";
import rate_limiter_registration_default from "../middleware/rate-limiter-registration.js";
import { MetaService } from "../services/meta.js";
import use_collection_default from "../middleware/use-collection.js";
import { validateBatch } from "../middleware/validate-batch.js";
import { ErrorCode, ForbiddenError, InvalidCredentialsError, InvalidPayloadError, isDirectusError } from "@directus/errors";
import express from "express";
import Joi from "joi";
//#region src/controllers/users.ts
const router = express.Router();
router.use(use_collection_default("directus_users"));
router.post("/", async_handler_default(async (req, res, next) => {
const service = new UsersService({
accountability: req.accountability,
schema: req.schema
});
const savedKeys = [];
if (Array.isArray(req.body)) {
const keys = await service.createMany(req.body);
savedKeys.push(...keys);
} else {
const key = await service.createOne(req.body);
savedKeys.push(key);
}
try {
if (Array.isArray(req.body)) {
const items = await service.readMany(savedKeys, req.sanitizedQuery);
res.locals["payload"] = { data: items };
} else {
const item = await service.readOne(savedKeys[0], req.sanitizedQuery);
res.locals["payload"] = { data: item };
}
} catch (error) {
if (isDirectusError(error, ErrorCode.Forbidden)) return next();
throw error;
}
return next();
}), respond);
const readHandler = async_handler_default(async (req, res, next) => {
const service = new UsersService({
accountability: req.accountability,
schema: req.schema
});
const metaService = new MetaService({
accountability: req.accountability,
schema: req.schema
});
const item = await service.readByQuery(req.sanitizedQuery);
const meta = await metaService.getMetaForQuery("directus_users", req.sanitizedQuery);
res.locals["payload"] = {
data: item || null,
meta
};
return next();
});
router.get("/", validateBatch("read"), readHandler, respond);
router.search("/", validateBatch("read"), readHandler, respond);
router.get("/me", async_handler_default(async (req, res, next) => {
if (req.accountability?.share) {
res.locals["payload"] = { data: { share: req.accountability?.share } };
return next();
}
if (!req.accountability?.user) throw new InvalidCredentialsError();
const service = new UsersService({
accountability: req.accountability,
schema: req.schema
});
try {
const item = await service.readOne(req.accountability.user, req.sanitizedQuery);
res.locals["payload"] = { data: item || null };
} catch (error) {
if (isDirectusError(error, ErrorCode.Forbidden)) {
res.locals["payload"] = { data: { id: req.accountability.user } };
return next();
}
throw error;
}
return next();
}), respond);
router.get("/:pk", async_handler_default(async (req, res, next) => {
if (req.path.endsWith("me")) return next();
const items = await new UsersService({
accountability: req.accountability,
schema: req.schema
}).readOne(req.params["pk"], req.sanitizedQuery);
res.locals["payload"] = { data: items || null };
return next();
}), respond);
router.patch("/me", async_handler_default(async (req, res, next) => {
if (!req.accountability?.user) throw new InvalidCredentialsError();
const service = new UsersService({
accountability: req.accountability,
schema: req.schema
});
const primaryKey = await service.updateOne(req.accountability.user, req.body);
const item = await service.readOne(primaryKey, req.sanitizedQuery);
res.locals["payload"] = { data: item || null };
return next();
}), respond);
router.patch("/me/track/page", async_handler_default(async (req, _res, next) => {
if (!req.accountability?.user) throw new InvalidCredentialsError();
if (!req.body.last_page) throw new InvalidPayloadError({ reason: `"last_page" key is required` });
await new UsersService({ schema: req.schema }).updateOne(req.accountability.user, { last_page: req.body.last_page }, { autoPurgeCache: false });
return next();
}), respond);
router.patch("/", validateBatch("update"), async_handler_default(async (req, res, next) => {
const service = new UsersService({
accountability: req.accountability,
schema: req.schema
});
let keys = [];
if (Array.isArray(req.body)) keys = await service.updateBatch(req.body);
else if (req.body.keys) keys = await service.updateMany(req.body.keys, req.body.data);
else {
const sanitizedQuery = await sanitizeQuery(req.body.query, req.schema, req.accountability);
keys = await service.updateByQuery(sanitizedQuery, req.body.data);
}
try {
const result = await service.readMany(keys, req.sanitizedQuery);
res.locals["payload"] = { data: result };
} catch (error) {
if (isDirectusError(error, ErrorCode.Forbidden)) return next();
throw error;
}
return next();
}), respond);
router.patch("/:pk", async_handler_default(async (req, res, next) => {
const service = new UsersService({
accountability: req.accountability,
schema: req.schema
});
const primaryKey = await service.updateOne(req.params["pk"], req.body);
try {
const item = await service.readOne(primaryKey, req.sanitizedQuery);
res.locals["payload"] = { data: item || null };
} catch (error) {
if (isDirectusError(error, ErrorCode.Forbidden)) return next();
throw error;
}
return next();
}), respond);
router.delete("/", validateBatch("delete"), async_handler_default(async (req, _res, next) => {
const service = new UsersService({
accountability: req.accountability,
schema: req.schema
});
if (Array.isArray(req.body)) await service.deleteMany(req.body);
else if (req.body.keys) await service.deleteMany(req.body.keys);
else {
const sanitizedQuery = await sanitizeQuery(req.body.query, req.schema, req.accountability);
await service.deleteByQuery(sanitizedQuery);
}
return next();
}), respond);
router.delete("/:pk", async_handler_default(async (req, _res, next) => {
await new UsersService({
accountability: req.accountability,
schema: req.schema
}).deleteOne(req.params["pk"]);
return next();
}), respond);
const inviteSchema = Joi.object({
email: Joi.alternatives(Joi.string().email(), Joi.array().items(Joi.string().email())).required(),
role: Joi.string().uuid({ version: "uuidv4" }).required(),
invite_url: Joi.string().uri()
});
router.post("/invite", async_handler_default(async (req, _res, next) => {
const { error } = inviteSchema.validate(req.body);
if (error) throw new InvalidPayloadError({ reason: error.message });
const service = new UsersService({
accountability: req.accountability,
schema: req.schema
});
try {
await service.inviteUser(req.body.email, req.body.role, req.body.invite_url || null);
} catch (error$1) {
if (isDirectusError(error$1, ErrorCode.Forbidden)) return next();
throw error$1;
}
return next();
}), respond);
const acceptInviteSchema = Joi.object({
token: Joi.string().required(),
password: Joi.string().required()
});
router.post("/invite/accept", async_handler_default(async (req, _res, next) => {
const { error } = acceptInviteSchema.validate(req.body);
if (error) throw new InvalidPayloadError({ reason: error.message });
await new UsersService({
accountability: req.accountability,
schema: req.schema
}).acceptInvite(req.body.token, req.body.password);
return next();
}), respond);
router.post("/me/tfa/generate/", async_handler_default(async (req, res, next) => {
if (!req.accountability?.user) throw new InvalidCredentialsError();
const requiresPassword = (await getDatabase().select("provider").from("directus_users").where({ id: req.accountability.user }).first())?.["provider"] === DEFAULT_AUTH_PROVIDER;
if (requiresPassword && !req.body.password) throw new InvalidPayloadError({ reason: `"password" is required` });
const service = new TFAService({
accountability: req.accountability,
schema: req.schema
});
if (requiresPassword) await new AuthenticationService({
accountability: req.accountability,
schema: req.schema
}).verifyPassword(req.accountability.user, req.body.password);
const { url, secret } = await service.generateTFA(req.accountability.user, requiresPassword);
res.locals["payload"] = { data: {
secret,
otpauth_url: url
} };
return next();
}), respond);
router.post("/me/tfa/enable/", async_handler_default(async (req, _res, next) => {
if (!req.accountability?.user) throw new InvalidCredentialsError();
if (!req.body.secret) throw new InvalidPayloadError({ reason: `"secret" is required` });
if (!req.body.otp) throw new InvalidPayloadError({ reason: `"otp" is required` });
await new TFAService({
accountability: req.accountability,
schema: req.schema
}).enableTFA(req.accountability.user, req.body.otp, req.body.secret);
return next();
}), respond);
router.post("/me/tfa/disable", async_handler_default(async (req, _res, next) => {
if (!req.accountability?.user) throw new InvalidCredentialsError();
if (!req.body.otp) throw new InvalidPayloadError({ reason: `"otp" is required` });
const service = new TFAService({
accountability: req.accountability,
schema: req.schema
});
if (await service.verifyOTP(req.accountability.user, req.body.otp) === false) throw new InvalidPayloadError({ reason: `"otp" is invalid` });
await service.disableTFA(req.accountability.user);
return next();
}), respond);
router.post("/:pk/tfa/disable", async_handler_default(async (req, _res, next) => {
if (!req.accountability?.user) throw new InvalidCredentialsError();
if (!req.accountability.admin || !req.params["pk"]) throw new ForbiddenError();
await new TFAService({
accountability: req.accountability,
schema: req.schema
}).disableTFA(req.params["pk"]);
return next();
}), respond);
const registerSchema = Joi.object({
email: Joi.string().email().required(),
password: Joi.string().required(),
verification_url: Joi.string().uri(),
first_name: Joi.string(),
last_name: Joi.string()
});
router.post("/register", rate_limiter_registration_default, async_handler_default(async (req, _res, next) => {
const { error, value } = registerSchema.validate(req.body);
if (error) throw new InvalidPayloadError({ reason: error.message });
await new UsersService({
accountability: null,
schema: req.schema
}).registerUser(value);
return next();
}), respond);
const verifyRegistrationSchema = Joi.string();
router.get("/register/verify-email", async_handler_default(async (req, res, _next) => {
const { error, value } = verifyRegistrationSchema.validate(req.query["token"]);
if (error) return res.redirect("/admin/login");
const id = await new UsersService({
accountability: null,
schema: req.schema
}).verifyRegistration(value);
return res.redirect(`/admin/users/${id}`);
}), respond);
var users_default = router;
//#endregion
export { users_default as default };