iceshrimp/src/server/api/endpoints/users/search.ts
syuilo 4e15337a64 Introduce OpenAPI specs (#4351)
* wip

* wip

* wip

* Update index.ts

* Update gen-openapi-spec.ts

* Update api.ja-JP.md

* Fix

* Improve doc

* Update gen-openapi-spec.ts

* Update redoc.html

* Improve doc

* Update gen-openapi-spec.ts

* Improve doc

* Update CHANGELOG.md
2019-02-23 11:20:58 +09:00

87 lines
1.7 KiB
TypeScript

import $ from 'cafy';
import * as escapeRegexp from 'escape-regexp';
import User, { pack, validateUsername, IUser } from '../../../../models/user';
import define from '../../define';
export const meta = {
desc: {
'ja-JP': 'ユーザーを検索します。'
},
tags: ['users'],
requireCredential: false,
params: {
query: {
validator: $.str,
desc: {
'ja-JP': 'クエリ'
}
},
offset: {
validator: $.optional.num.min(0),
default: 0,
desc: {
'ja-JP': 'オフセット'
}
},
limit: {
validator: $.optional.num.range(1, 100),
default: 10,
desc: {
'ja-JP': '取得する数'
}
},
localOnly: {
validator: $.optional.bool,
default: false,
desc: {
'ja-JP': 'ローカルユーザーのみ検索対象にするか否か'
}
},
detail: {
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': '詳細なユーザー情報を含めるか否か'
}
},
},
};
export default define(meta, async (ps, me) => {
const isUsername = validateUsername(ps.query.replace('@', ''), !ps.localOnly);
let users: IUser[] = [];
if (isUsername) {
users = await User
.find({
host: null,
usernameLower: new RegExp('^' + escapeRegexp(ps.query.replace('@', '').toLowerCase()))
}, {
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);
}
}
return await Promise.all(users.map(user => pack(user, me, { detail: ps.detail })));
});