feat: Webhook (#8457)

* feat: introduce webhook

* wip

* wip

* wip

* Update CHANGELOG.md

packages/backend/src/server/api/endpoints.ts

@@ -202,6 +202,11 @@ import * as ep___i_unpin from './endpoints/i/unpin.js';
 import * as ep___i_updateEmail from './endpoints/i/update-email.js';
 import * as ep___i_update from './endpoints/i/update.js';
 import * as ep___i_userGroupInvites from './endpoints/i/user-group-invites.js';
+import * as ep___i_webhooks_create from './endpoints/i/webhooks/create.js';
+import * as ep___i_webhooks_show from './endpoints/i/webhooks/show.js';
+import * as ep___i_webhooks_list from './endpoints/i/webhooks/list.js';
+import * as ep___i_webhooks_update from './endpoints/i/webhooks/update.js';
+import * as ep___i_webhooks_delete from './endpoints/i/webhooks/delete.js';
 import * as ep___messaging_history from './endpoints/messaging/history.js';
 import * as ep___messaging_messages from './endpoints/messaging/messages.js';
 import * as ep___messaging_messages_create from './endpoints/messaging/messages/create.js';
@@ -507,6 +512,11 @@ const eps = [
 	['i/update-email', ep___i_updateEmail],
 	['i/update', ep___i_update],
 	['i/user-group-invites', ep___i_userGroupInvites],
+	['i/webhooks/create', ep___i_webhooks_create],
+	['i/webhooks/list', ep___i_webhooks_list],
+	['i/webhooks/show', ep___i_webhooks_show],
+	['i/webhooks/update', ep___i_webhooks_update],
+	['i/webhooks/delete', ep___i_webhooks_delete],
 	['messaging/history', ep___messaging_history],
 	['messaging/messages', ep___messaging_messages],
 	['messaging/messages/create', ep___messaging_messages_create],

packages/backend/src/server/api/endpoints/i/webhooks/create.ts

@@ -0,0 +1,43 @@
+import define from '../../../define.js';
+import { genId } from '@/misc/gen-id.js';
+import { Webhooks } from '@/models/index.js';
+import { publishInternalEvent } from '@/services/stream.js';
+import { webhookEventTypes } from '@/models/entities/webhook.js';
+
+export const meta = {
+	tags: ['webhooks'],
+
+	requireCredential: true,
+
+	kind: 'write:account',
+} as const;
+
+export const paramDef = {
+	type: 'object',
+	properties: {
+		name: { type: 'string', minLength: 1, maxLength: 100 },
+		url: { type: 'string', minLength: 1, maxLength: 1024 },
+		secret: { type: 'string', minLength: 1, maxLength: 1024 },
+		on: { type: 'array', items: {
+			type: 'string', enum: webhookEventTypes,
+		} },
+	},
+	required: ['name', 'url', 'secret', 'on'],
+} as const;
+
+// eslint-disable-next-line import/no-default-export
+export default define(meta, paramDef, async (ps, user) => {
+	const webhook = await Webhooks.insert({
+		id: genId(),
+		createdAt: new Date(),
+		userId: user.id,
+		name: ps.name,
+		url: ps.url,
+		secret: ps.secret,
+		on: ps.on,
+	}).then(x => Webhooks.findOneByOrFail(x.identifiers[0]));
+
+	publishInternalEvent('webhookCreated', webhook);
+
+	return webhook;
+});

packages/backend/src/server/api/endpoints/i/webhooks/delete.ts

@@ -0,0 +1,44 @@
+import define from '../../../define.js';
+import { ApiError } from '../../../error.js';
+import { Webhooks } from '@/models/index.js';
+import { publishInternalEvent } from '@/services/stream.js';
+
+export const meta = {
+	tags: ['webhooks'],
+
+	requireCredential: true,
+
+	kind: 'write:account',
+
+	errors: {
+		noSuchWebhook: {
+			message: 'No such webhook.',
+			code: 'NO_SUCH_WEBHOOK',
+			id: 'bae73e5a-5522-4965-ae19-3a8688e71d82',
+		},
+	},
+} as const;
+
+export const paramDef = {
+	type: 'object',
+	properties: {
+		webhookId: { type: 'string', format: 'misskey:id' },
+	},
+	required: ['webhookId'],
+} as const;
+
+// eslint-disable-next-line import/no-default-export
+export default define(meta, paramDef, async (ps, user) => {
+	const webhook = await Webhooks.findOneBy({
+		id: ps.webhookId,
+		userId: user.id,
+	});
+
+	if (webhook == null) {
+		throw new ApiError(meta.errors.noSuchWebhook);
+	}
+
+	await Webhooks.delete(webhook.id);
+
+	publishInternalEvent('webhookDeleted', webhook);
+});

packages/backend/src/server/api/endpoints/i/webhooks/list.ts

@@ -0,0 +1,25 @@
+import define from '../../../define.js';
+import { Webhooks } from '@/models/index.js';
+
+export const meta = {
+	tags: ['webhooks', 'account'],
+
+	requireCredential: true,
+
+	kind: 'read:account',
+} as const;
+
+export const paramDef = {
+	type: 'object',
+	properties: {},
+	required: [],
+} as const;
+
+// eslint-disable-next-line import/no-default-export
+export default define(meta, paramDef, async (ps, me) => {
+	const webhooks = await Webhooks.findBy({
+		userId: me.id,
+	});
+
+	return webhooks;
+});

packages/backend/src/server/api/endpoints/i/webhooks/show.ts

@@ -0,0 +1,41 @@
+import define from '../../../define.js';
+import { ApiError } from '../../../error.js';
+import { Webhooks } from '@/models/index.js';
+
+export const meta = {
+	tags: ['webhooks'],
+
+	requireCredential: true,
+
+	kind: 'read:account',
+
+	errors: {
+		noSuchWebhook: {
+			message: 'No such webhook.',
+			code: 'NO_SUCH_WEBHOOK',
+			id: '50f614d9-3047-4f7e-90d8-ad6b2d5fb098',
+		},
+	},
+} as const;
+
+export const paramDef = {
+	type: 'object',
+	properties: {
+		webhookId: { type: 'string', format: 'misskey:id' },
+	},
+	required: ['webhookId'],
+} as const;
+
+// eslint-disable-next-line import/no-default-export
+export default define(meta, paramDef, async (ps, user) => {
+	const webhook = await Webhooks.findOneBy({
+		id: ps.webhookId,
+		userId: user.id,
+	});
+
+	if (webhook == null) {
+		throw new ApiError(meta.errors.noSuchWebhook);
+	}
+
+	return webhook;
+});

packages/backend/src/server/api/endpoints/i/webhooks/update.ts

@@ -0,0 +1,59 @@
+import define from '../../../define.js';
+import { ApiError } from '../../../error.js';
+import { Webhooks } from '@/models/index.js';
+import { publishInternalEvent } from '@/services/stream.js';
+import { webhookEventTypes } from '@/models/entities/webhook.js';
+
+export const meta = {
+	tags: ['webhooks'],
+
+	requireCredential: true,
+
+	kind: 'write:account',
+
+	errors: {
+		noSuchWebhook: {
+			message: 'No such webhook.',
+			code: 'NO_SUCH_WEBHOOK',
+			id: 'fb0fea69-da18-45b1-828d-bd4fd1612518',
+		},
+	},
+
+} as const;
+
+export const paramDef = {
+	type: 'object',
+	properties: {
+		webhookId: { type: 'string', format: 'misskey:id' },
+		name: { type: 'string', minLength: 1, maxLength: 100 },
+		url: { type: 'string', minLength: 1, maxLength: 1024 },
+		secret: { type: 'string', minLength: 1, maxLength: 1024 },
+		on: { type: 'array', items: {
+			type: 'string', enum: webhookEventTypes,
+		} },
+		active: { type: 'boolean' },
+	},
+	required: ['webhookId', 'name', 'url', 'secret', 'on', 'active'],
+} as const;
+
+// eslint-disable-next-line import/no-default-export
+export default define(meta, paramDef, async (ps, user) => {
+	const webhook = await Webhooks.findOneBy({
+		id: ps.webhookId,
+		userId: user.id,
+	});
+
+	if (webhook == null) {
+		throw new ApiError(meta.errors.noSuchWebhook);
+	}
+
+	await Webhooks.update(webhook.id, {
+		name: ps.name,
+		url: ps.url,
+		secret: ps.secret,
+		on: ps.on,
+		active: ps.active,
+	});
+
+	publishInternalEvent('webhookUpdated', webhook);
+});

packages/backend/src/server/api/stream/types.ts

@@ -15,6 +15,7 @@ import { AbuseUserReport } from '@/models/entities/abuse-user-report.js';
 import { Signin } from '@/models/entities/signin.js';
 import { Page } from '@/models/entities/page.js';
 import { Packed } from '@/misc/schema.js';
+import { Webhook } from '@/models/entities/webhook';
 
 //#region Stream type-body definitions
 export interface InternalStreamTypes {
@@ -23,6 +24,9 @@ export interface InternalStreamTypes {
 	userChangeModeratorState: { id: User['id']; isModerator: User['isModerator']; };
 	userTokenRegenerated: { id: User['id']; oldToken: User['token']; newToken: User['token']; };
 	remoteUserUpdated: { id: User['id']; };
+	webhookCreated: Webhook;
+	webhookDeleted: Webhook;
+	webhookUpdated: Webhook;
 	antennaCreated: Antenna;
 	antennaDeleted: Antenna;
 	antennaUpdated: Antenna;