summaryrefslogtreecommitdiff
path: root/packages/backend/src/server/api/endpoints/users/search-by-username-and-host.ts
blob: d1d6354d53f34a751a93487e4a3810344c098bac (plain)
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
/*
 * SPDX-FileCopyrightText: syuilo and misskey-project
 * SPDX-License-Identifier: AGPL-3.0-only
 */

import { Injectable } from '@nestjs/common';
import { Endpoint } from '@/server/api/endpoint-base.js';
import { UserSearchService } from '@/core/UserSearchService.js';

export const meta = {
	tags: ['users'],

	requireCredential: false,

	description: 'Search for a user by username and/or host.',

	res: {
		type: 'array',
		optional: false, nullable: false,
		items: {
			type: 'object',
			optional: false, nullable: false,
			ref: 'User',
		},
	},
} as const;

export const paramDef = {
	allOf: [
		{
			anyOf: [
				{
					type: 'object',
					properties: {
						username: { type: 'string', nullable: true },
					},
					required: ['username'],
				},
				{
					type: 'object',
					properties: {
						host: { type: 'string', nullable: true },
					},
					required: ['host'],
				},
			],
		},
		{
			type: 'object',
			properties: {
				limit: { type: 'integer', minimum: 1, maximum: 100, default: 10 },
				detail: { type: 'boolean', default: true },
			},
		},
	],
} as const;

@Injectable()
export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-disable-line import/no-default-export
	constructor(
		private userSearchService: UserSearchService,
	) {
		super(meta, paramDef, (ps, me) => {
			return this.userSearchService.searchByUsernameAndHost({
				username: 'username' in ps ? ps.username : undefined,
				host: 'host' in ps ? ps.host : undefined,
			}, {
				limit: ps.limit,
				detail: ps.detail,
			}, me);
		});
	}
}