misskey/src/server/api/endpoints/users/search.ts

94 lines
1.8 KiB
TypeScript
Raw Normal View History

2017-03-08 19:50:09 +01:00
import $ from 'cafy';
import * as escapeRegexp from 'escape-regexp';
2018-11-02 05:47:44 +01:00
import User, { pack, validateUsername, IUser } from '../../../../models/user';
import define from '../../define';
2018-08-06 11:28:27 +02:00
export const meta = {
desc: {
2018-08-28 23:59:43 +02:00
'ja-JP': 'ユーザーを検索します。'
2018-08-06 11:28:27 +02:00
},
tags: ['users'],
2018-08-06 11:28:27 +02:00
requireCredential: false,
params: {
2018-11-01 19:32:24 +01:00
query: {
validator: $.str,
2018-08-06 11:28:27 +02:00
desc: {
2018-08-28 23:59:43 +02:00
'ja-JP': 'クエリ'
2018-08-06 11:28:27 +02:00
}
2018-11-01 19:32:24 +01:00
},
2018-08-06 11:28:27 +02:00
2018-11-01 19:32:24 +01:00
offset: {
2019-02-13 08:33:07 +01:00
validator: $.optional.num.min(0),
2018-08-06 11:28:27 +02:00
default: 0,
desc: {
2018-08-28 23:59:43 +02:00
'ja-JP': 'オフセット'
2018-08-06 11:28:27 +02:00
}
2018-11-01 19:32:24 +01:00
},
2018-08-06 11:28:27 +02:00
2018-11-01 19:32:24 +01:00
limit: {
2019-02-13 08:33:07 +01:00
validator: $.optional.num.range(1, 100),
2018-08-06 11:28:27 +02:00
default: 10,
desc: {
2018-08-28 23:59:43 +02:00
'ja-JP': '取得する数'
2018-08-06 11:28:27 +02:00
}
2018-11-01 19:32:24 +01:00
},
2018-08-06 11:28:27 +02:00
2018-11-01 19:32:24 +01:00
localOnly: {
2019-02-13 08:33:07 +01:00
validator: $.optional.bool,
2018-08-06 11:28:27 +02:00
default: false,
desc: {
2018-08-28 23:59:43 +02:00
'ja-JP': 'ローカルユーザーのみ検索対象にするか否か'
2018-08-06 11:28:27 +02:00
}
2018-11-01 19:32:24 +01:00
},
2018-12-01 22:44:18 +01:00
detail: {
2019-02-13 08:33:07 +01:00
validator: $.optional.bool,
2018-12-01 22:44:18 +01:00
default: true,
desc: {
'ja-JP': '詳細なユーザー情報を含めるか否か'
}
},
2018-08-06 11:28:27 +02:00
},
2019-02-24 11:42:26 +01:00
res: {
type: 'array',
items: {
type: 'User',
}
},
2018-08-06 11:28:27 +02:00
};
2016-12-28 23:49:51 +01:00
export default define(meta, async (ps, me) => {
const isUsername = validateUsername(ps.query.replace('@', ''), !ps.localOnly);
2018-08-06 11:28:27 +02:00
let users: IUser[] = [];
if (isUsername) {
users = await User
.find({
host: null,
usernameLower: new RegExp('^' + escapeRegexp(ps.query.replace('@', '').toLowerCase()))
2016-12-28 23:49:51 +01:00
}, {
2018-08-06 11:28:27 +02:00
limit: ps.limit,
skip: ps.offset
});
if (users.length < ps.limit && !ps.localOnly) {
const otherUsers = await User
.find({
host: { $ne: null },
usernameLower: new RegExp('^' + escapeRegexp(ps.query.replace('@', '').toLowerCase()))
}, {
limit: ps.limit - users.length
});
users = users.concat(otherUsers);
}
}
2016-12-28 23:49:51 +01:00
return await Promise.all(users.map(user => pack(user, me, { detail: ps.detail })));
});