Sharkey/src/server/api/endpoints/i/notifications.ts

124 lines
2.5 KiB
TypeScript
Raw Normal View History

2019-02-05 04:48:08 +02:00
import $ from 'cafy';
import ID, { transform } from '../../../../misc/cafy-id';
2018-03-29 14:32:18 +03:00
import Notification from '../../../../models/notification';
import { packMany } from '../../../../models/notification';
2018-04-19 06:43:25 +03:00
import { getFriendIds } from '../../common/get-friends';
import read from '../../common/read-notification';
2018-11-02 06:47:44 +02:00
import define from '../../define';
2019-02-01 02:57:51 +02:00
import { getHideUserIds } from '../../common/get-hide-users';
2016-12-29 00:49:51 +02:00
2018-11-01 20:32:24 +02:00
export const meta = {
desc: {
'ja-JP': '通知一覧を取得します。',
'en-US': 'Get notifications.'
},
requireCredential: true,
kind: 'account-read',
params: {
limit: {
2019-02-13 09:33:07 +02:00
validator: $.optional.num.range(1, 100),
2018-11-01 20:32:24 +02:00
default: 10
},
2016-12-29 00:49:51 +02:00
2018-11-01 20:32:24 +02:00
sinceId: {
2019-02-13 09:33:07 +02:00
validator: $.optional.type(ID),
2018-11-01 20:32:24 +02:00
transform: transform,
},
2016-12-29 00:49:51 +02:00
2018-11-01 20:32:24 +02:00
untilId: {
2019-02-13 09:33:07 +02:00
validator: $.optional.type(ID),
2018-11-01 20:32:24 +02:00
transform: transform,
},
2016-12-29 00:49:51 +02:00
2018-11-01 20:32:24 +02:00
following: {
2019-02-13 09:33:07 +02:00
validator: $.optional.bool,
2018-11-01 20:32:24 +02:00
default: false
},
2017-03-03 01:56:07 +02:00
2018-11-01 20:32:24 +02:00
markAsRead: {
2019-02-13 09:33:07 +02:00
validator: $.optional.bool,
2018-11-01 20:32:24 +02:00
default: true
},
includeTypes: {
2019-02-13 09:33:07 +02:00
validator: $.optional.arr($.str.or(['follow', 'mention', 'reply', 'renote', 'quote', 'reaction', 'poll_vote', 'receiveFollowRequest'])),
default: [] as string[]
},
excludeTypes: {
2019-02-13 09:33:07 +02:00
validator: $.optional.arr($.str.or(['follow', 'mention', 'reply', 'renote', 'quote', 'reaction', 'poll_vote', 'receiveFollowRequest'])),
default: [] as string[]
2018-11-01 20:32:24 +02:00
}
}
};
2018-11-02 06:47:44 +02:00
export default define(meta, (ps, user) => new Promise(async (res, rej) => {
2018-03-29 08:48:47 +03:00
// Check if both of sinceId and untilId is specified
2018-11-01 20:32:24 +02:00
if (ps.sinceId && ps.untilId) {
2018-03-29 08:48:47 +03:00
return rej('cannot set sinceId and untilId');
2016-12-29 00:49:51 +02:00
}
2019-02-01 02:57:51 +02:00
const hideUserIds = await getHideUserIds(user);
2017-12-22 00:26:23 +02:00
2016-12-29 00:49:51 +02:00
const query = {
2018-03-29 08:48:47 +03:00
notifieeId: user._id,
2017-12-22 00:26:23 +02:00
$and: [{
2018-03-29 08:48:47 +03:00
notifierId: {
2019-02-01 02:57:51 +02:00
$nin: hideUserIds
2017-12-22 00:26:23 +02:00
}
}]
2017-03-03 01:56:07 +02:00
} as any;
2016-12-29 00:49:51 +02:00
const sort = {
_id: -1
};
2018-11-01 20:32:24 +02:00
if (ps.following) {
2017-12-22 00:26:23 +02:00
// ID list of the user itself and other users who the user follows
2018-04-19 06:43:25 +03:00
const followingIds = await getFriendIds(user._id);
2016-12-29 00:49:51 +02:00
2017-12-22 00:26:23 +02:00
query.$and.push({
2018-03-29 08:48:47 +03:00
notifierId: {
2017-12-22 00:26:23 +02:00
$in: followingIds
}
});
2016-12-29 00:49:51 +02:00
}
2018-11-01 20:32:24 +02:00
if (ps.sinceId) {
2016-12-29 00:49:51 +02:00
sort._id = 1;
query._id = {
2018-11-01 20:32:24 +02:00
$gt: ps.sinceId
2016-12-29 00:49:51 +02:00
};
2018-11-01 20:32:24 +02:00
} else if (ps.untilId) {
2016-12-29 00:49:51 +02:00
query._id = {
2018-11-01 20:32:24 +02:00
$lt: ps.untilId
2016-12-29 00:49:51 +02:00
};
}
if (ps.includeTypes.length > 0) {
query.type = {
$in: ps.includeTypes
};
} else if (ps.excludeTypes.length > 0) {
query.type = {
$nin: ps.excludeTypes
};
}
2016-12-29 00:49:51 +02:00
const notifications = await Notification
2017-01-17 04:11:22 +02:00
.find(query, {
2018-11-01 20:32:24 +02:00
limit: ps.limit,
2016-12-29 00:49:51 +02:00
sort: sort
2017-01-17 04:11:22 +02:00
});
2016-12-29 00:49:51 +02:00
res(await packMany(notifications));
2016-12-29 00:49:51 +02:00
// Mark all as read
2018-11-01 20:32:24 +02:00
if (notifications.length > 0 && ps.markAsRead) {
read(user._id, notifications);
2016-12-29 00:49:51 +02:00
}
2018-11-02 06:47:44 +02:00
}));