misskey/src/server/api/endpoints/users/following.ts
syuilo 52774bbe64
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

116 lines
2.3 KiB
TypeScript

import $ from 'cafy';
import ID, { transform } from '../../../../misc/cafy-id';
import User from '../../../../models/user';
import Following from '../../../../models/following';
import { pack } from '../../../../models/user';
import { getFriendIds } from '../../common/get-friends';
import define from '../../define';
import { ApiError } from '../../error';
export const meta = {
desc: {
'ja-JP': '指定したユーザーのフォロー一覧を取得します。',
'en-US': 'Get following users of a user.'
},
tags: ['users'],
requireCredential: false,
params: {
userId: {
validator: $.optional.type(ID),
transform: transform,
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
username: {
validator: $.optional.str
},
host: {
validator: $.optional.nullable.str
},
limit: {
validator: $.optional.num.range(1, 100),
default: 10
},
cursor: {
validator: $.optional.type(ID),
default: null as any,
transform: transform,
},
iknow: {
validator: $.optional.bool,
default: false,
}
},
errors: {
noSuchUser: {
message: 'No such user.',
code: 'NO_SUCH_USER',
id: '63e4aba4-4156-4e53-be25-c9559e42d71b'
}
}
};
export default define(meta, async (ps, me) => {
const q: any = ps.userId != null
? { _id: ps.userId }
: { usernameLower: ps.username.toLowerCase(), host: ps.host };
const user = await User.findOne(q);
if (user === null) {
throw new ApiError(meta.errors.noSuchUser);
}
const query = {
followerId: user._id
} as any;
// ログインしていてかつ iknow フラグがあるとき
if (me && ps.iknow) {
// Get my friends
const myFriends = await getFriendIds(me._id);
query.followeeId = {
$in: myFriends
};
}
// カーソルが指定されている場合
if (ps.cursor) {
query._id = {
$lt: ps.cursor
};
}
// Get followers
const following = await Following
.find(query, {
limit: ps.limit + 1,
sort: { _id: -1 }
});
// 「次のページ」があるかどうか
const inStock = following.length === ps.limit + 1;
if (inStock) {
following.pop();
}
const users = await Promise.all(following.map(f => pack(f.followeeId, me, { detail: true })));
return {
users: users,
next: inStock ? following[following.length - 1]._id : null,
};
});