mizzkey/packages/sw/src/scripts/create-notification.ts

/*
 * SPDX-FileCopyrightText: syuilo and misskey-project
 * SPDX-License-Identifier: AGPL-3.0-only
 */

/*
 * Notification manager for SW
 */
import type { BadgeNames, PushNotificationDataMap } from '@/types.js';
import { char2fileName } from '@/scripts/twemoji-base.js';
import { cli } from '@/scripts/operations.js';
import { getAccountFromId } from '@/scripts/get-account-from-id.js';
import { swLang } from '@/scripts/lang.js';
import { getUserName } from '@/scripts/get-user-name.js';

const closeNotificationsByTags = async (tags: string[]): Promise<void> => {
	for (const n of (await Promise.all(tags.map(tag => globalThis.registration.getNotifications({ tag })))).flat()) {
		n.close();
	}
};

const iconUrl = (name: BadgeNames): string => `/static-assets/tabler-badges/${name}.png`;
/* How to add a new badge:
 * 1. Find the icon and download png from https://tabler-icons.io/
 * 2. vips resize ~/Downloads/icon-name.png vipswork.png 0.4; vips scRGB2BW vipswork.png ~/icon-name.png"[compression=9,strip]"; rm vipswork.png;
 * 3. mv ~/icon-name.png ~/misskey/packages/backend/assets/tabler-badges/
 * 4. Add 'icon-name' to BadgeNames
 * 5. Add `badge: iconUrl('icon-name'),`
 */

export async function createNotification<K extends keyof PushNotificationDataMap>(data: PushNotificationDataMap[K]): Promise<void> {
	const n = await composeNotification(data);

	if (n) {
		return globalThis.registration.showNotification(...n);
	} else {
		console.error('Could not compose notification', data);
		return createEmptyNotification();
	}
}

async function composeNotification(data: PushNotificationDataMap[keyof PushNotificationDataMap]): Promise<[string, NotificationOptions] | null> {
	const i18n = await (swLang.i18n ?? swLang.fetchLocale());
	switch (data.type) {
		/*
		case 'driveFileCreated': // TODO (Server Side)
			return [i18n.ts._notification.fileUploaded, {
				body: body.name,
				icon: body.url,
				data
			}];
		*/
		case 'notification':
			switch (data.body.type) {
				case 'follow': {
					// users/showの型定義をswos.apiへ当てはめるのが困難なのでapiFetch.requestを直接使用
					const account = await getAccountFromId(data.userId);
					if (!account) return null;
					const userDetail = await cli.request('users/show', { userId: data.body.userId }, account.token);
					return [i18n.ts._notification.youWereFollowed, {
						body: getUserName(data.body.user),
						icon: data.body.user.avatarUrl ?? undefined,
						badge: iconUrl('user-plus'),
						data,
						actions: userDetail.isFollowing ? [] : [
							{
								action: 'follow',
								title: i18n.ts._notification._actions.followBack,
							},
						],
					}];
				}

				case 'mention':
					return [i18n.tsx._notification.youGotMention({ name: getUserName(data.body.user) }), {
						body: data.body.note.text ?? '',
						icon: data.body.user.avatarUrl ?? undefined,
						badge: iconUrl('at'),
						data,
						actions: [
							{
								action: 'reply',
								title: i18n.ts._notification._actions.reply,
							},
						],
					}];

				case 'reply':
					return [i18n.tsx._notification.youGotReply({ name: getUserName(data.body.user) }), {
						body: data.body.note.text ?? '',
						icon: data.body.user.avatarUrl ?? undefined,
						badge: iconUrl('arrow-back-up'),
						data,
						actions: [
							{
								action: 'reply',
								title: i18n.ts._notification._actions.reply,
							},
						],
					}];

				case 'renote':
					return [i18n.tsx._notification.youRenoted({ name: getUserName(data.body.user) }), {
						body: data.body.note.text ?? '',
						icon: data.body.user.avatarUrl ?? undefined,
						badge: iconUrl('repeat'),
						data,
						actions: [
							{
								action: 'showUser',
								title: getUserName(data.body.user),
							},
						],
					}];

				case 'quote':
					return [i18n.tsx._notification.youGotQuote({ name: getUserName(data.body.user) }), {
						body: data.body.note.text ?? '',
						icon: data.body.user.avatarUrl ?? undefined,
						badge: iconUrl('quote'),
						data,
						actions: [
							{
								action: 'reply',
								title: i18n.ts._notification._actions.reply,
							},
							...((data.body.note.visibility === 'public' || data.body.note.visibility === 'home') ? [
								{
									action: 'renote',
									title: i18n.ts._notification._actions.renote,
								},
							] : []),
						],
					}];

				case 'note':
					return [i18n.ts._notification.newNote + ': ' + getUserName(data.body.user), {
						body: data.body.note.text ?? '',
						icon: data.body.user.avatarUrl ?? undefined,
						data,
					}];

				case 'reaction': {
					let reaction = data.body.reaction;
					let badge: string | undefined;

					if (reaction.startsWith(':')) {
						// カスタム絵文字の場合
						const name = reaction.substring(1, reaction.length - 1);
						const badgeUrl = new URL(`/emoji/${name}.webp`, origin);
						badgeUrl.searchParams.set('badge', '1');
						badge = badgeUrl.href;
						reaction = name.split('@')[0];
					} else {
						// Unicode絵文字の場合
						badge = `/twemoji-badge/${char2fileName(reaction)}.png`;
					}

					if (await fetch(badge).then(res => res.status !== 200).catch(() => true)) {
						badge = iconUrl('plus');
					}

					const tag = `reaction:${data.body.note.id}`;
					return [`${reaction} ${getUserName(data.body.user)}`, {
						body: data.body.note.text ?? '',
						icon: data.body.user.avatarUrl ?? undefined,
						tag,
						badge,
						data,
						actions: [
							{
								action: 'showUser',
								title: getUserName(data.body.user),
							},
						],
					}];
				}

				case 'receiveFollowRequest':
					return [i18n.ts._notification.youReceivedFollowRequest, {
						body: getUserName(data.body.user),
						icon: data.body.user.avatarUrl ?? undefined,
						badge: iconUrl('user-plus'),
						data,
						actions: [
							{
								action: 'accept',
								title: i18n.ts.accept,
							},
							{
								action: 'reject',
								title: i18n.ts.reject,
							},
						],
					}];

				case 'followRequestAccepted':
					return [i18n.ts._notification.yourFollowRequestAccepted, {
						body: getUserName(data.body.user),
						icon: data.body.user.avatarUrl ?? undefined,
						badge: iconUrl('circle-check'),
						data,
					}];

				case 'achievementEarned':
					return [i18n.ts._notification.achievementEarned, {
						body: i18n.ts._achievements._types[`_${data.body.achievement}`].title,
						badge: iconUrl('medal'),
						data,
						tag: `achievement:${data.body.achievement}`,
					}];

				case 'login':
					return [i18n.ts._notification.login, {
						badge: iconUrl('login-2'),
						data,
					}];

				case 'exportCompleted': {
					const entityName = {
						antenna: i18n.ts.antennas,
						blocking: i18n.ts.blockedUsers,
						clip: i18n.ts.clips,
						customEmoji: i18n.ts.customEmojis,
						favorite: i18n.ts.favorites,
						following: i18n.ts.following,
						muting: i18n.ts.mutedUsers,
						note: i18n.ts.notes,
						userList: i18n.ts.lists,
					} as const satisfies Record<typeof data.body.exportedEntity, string>;

					return [i18n.tsx._notification.exportOfXCompleted({ x: entityName[data.body.exportedEntity] }), {
						badge: iconUrl('circle-check'),
						data,
					}];
				}

				case 'pollEnded':
					return [i18n.ts._notification.pollEnded, {
						body: data.body.note.text ?? '',
						badge: iconUrl('chart-arrows'),
						data,
					}];

				case 'app':
					return [data.body.header ?? data.body.body, {
						body: data.body.header ? data.body.body : '',
						icon: data.body.icon ?? undefined,
						data,
					}];

				case 'test':
					return [i18n.ts._notification.testNotification, {
						body: i18n.ts._notification.notificationWillBeDisplayedLikeThis,
						badge: iconUrl('bell'),
						data,
					}];

				default:
					return null;
			}
		case 'unreadAntennaNote':
			return [i18n.tsx._notification.unreadAntennaNote({ name: data.body.antenna.name }), {
				body: `${getUserName(data.body.note.user)}: ${data.body.note.text ?? ''}`,
				icon: data.body.note.user.avatarUrl ?? undefined,
				badge: iconUrl('antenna'),
				tag: `antenna:${data.body.antenna.id}`,
				data,
				renotify: true,
			}];
		default:
			return null;
	}
}

export async function createEmptyNotification(): Promise<void> {
	return new Promise<void>(async res => {
		const i18n = await (swLang.i18n ?? swLang.fetchLocale());

		await globalThis.registration.showNotification(
			(new URL(origin)).host,
			{
				body: `Misskey v${_VERSION_}`,
				silent: true,
				badge: iconUrl('null'),
				tag: 'read_notification',
				actions: [
					{
						action: 'markAllAsRead',
						title: i18n.ts.markAllAsRead,
					},
					{
						action: 'settings',
						title: i18n.ts.notificationSettings,
					},
				],
				data: {},
			},
		);

		setTimeout(async () => {
			try {
				await closeNotificationsByTags(['user_visible_auto_notification']);
			} finally {
				res();
			}
		}, 1000);
	});
}