Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ZMS-153 #686

Merged
merged 6 commits into from
May 9, 2024
Merged

ZMS-153 #686

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b3d48ce
Added submission api endpoint to api docs generation
NickOvt Apr 23, 2024
c01170f
Merge branch 'master' of github.com:nodemailer/wildduck
NickOvt Apr 29, 2024
3f1c3e0
Merge branch 'master' of github.com:nodemailer/wildduck
NickOvt Apr 29, 2024
f59229e
added Delete a webhook api endpoint to api docs generation
NickOvt May 6, 2024
e6a99bf
added Create new Webhook api endpoint to api docs generation
NickOvt May 6, 2024
254efca
Added List registered webhooks api endpoint to api docs generation
NickOvt May 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 116 additions & 24 deletions lib/api/webhooks.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,66 @@ const ObjectId = require('mongodb').ObjectId;
const tools = require('../tools');
const roles = require('../roles');
const { nextPageCursorSchema, previousPageCursorSchema, pageNrSchema, sessSchema, sessIPSchema } = require('../schemas');
const { successRes, totalRes, pageRes, previousCursorRes, nextCursorRes } = require('../schemas/response/general-schemas');

module.exports = (db, server) => {
server.get(
{ name: 'webhooks', path: '/webhooks' },
{
name: 'webhooks',
path: '/webhooks',
tags: ['Webhooks'],
summary: 'List registered Webhooks',
validationObjs: {
requestBody: {},
queryParams: {
type: Joi.string()
.empty('')
.lowercase()
.max(128)
.description('Prefix or exact match. Prefix match must end with ".*", eg "channel.*". Use "*" for all types'),
user: Joi.string().hex().lowercase().length(24).description('User ID'),
limit: Joi.number().default(20).min(1).max(250).description('How many records to return'),
next: nextPageCursorSchema,
previous: previousPageCursorSchema,
page: pageNrSchema,
sess: sessSchema,
ip: sessIPSchema
},
pathParams: {},
response: {
200: {
description: 'Success',
model: Joi.object({
success: successRes,
total: totalRes,
page: pageRes,
previousCursor: previousCursorRes,
nextCursor: nextCursorRes,
results: Joi.array()
.items(
Joi.object({
id: Joi.string().required().description('Webhooks unique ID (24 byte hex)'),
type: Joi.array().items(Joi.string()).required().description('An array of event types this webhook matches'),
user: Joi.string().required().description('User ID or null'),
url: Joi.string().required().description('Webhook URL')
}).$_setFlag('objectName', 'GetWebhooksResult')
)
.required()
.description('Webhook listing')
})
}
}
}
},
tools.responseWrapper(async (req, res) => {
res.charSet('utf-8');

const schema = Joi.object().keys({
type: Joi.string().empty('').lowercase().max(128),
user: Joi.string().hex().lowercase().length(24),
limit: Joi.number().default(20).min(1).max(250),
next: nextPageCursorSchema,
previous: previousPageCursorSchema,
page: pageNrSchema,
sess: sessSchema,
ip: sessIPSchema
const { pathParams, requestBody, queryParams } = req.route.spec.validationObjs;

const schema = Joi.object({
...pathParams,
...requestBody,
...queryParams
});

const result = schema.validate(req.params, {
Expand Down Expand Up @@ -137,18 +181,46 @@ module.exports = (db, server) => {
);

server.post(
'/webhooks',
{
path: '/webhooks',
tags: ['Webhooks'],
summary: 'Create new Webhook',
validationObjs: {
requestBody: {
type: Joi.array()
.items(Joi.string().trim().max(128).lowercase())
.required()
.description('An array of event types to match. For prefix match use ".*" at the end (eg. "user.*") or "*" for all types'),
user: Joi.string().hex().lowercase().length(24).description('User ID to match (only makes sense for user specific resources)'),
url: Joi.string()
.uri({ scheme: [/smtps?/, /https?/], allowRelative: false, relativeOnly: false })
.required()
.description('URL to POST data to'),
sess: sessSchema,
ip: sessIPSchema
},
queryParams: {},
pathParams: {},
response: {
200: {
description: 'Success',
model: Joi.object({
success: successRes,
id: Joi.string().required().description('ID of the Webhook')
})
}
}
}
},
tools.responseWrapper(async (req, res) => {
res.charSet('utf-8');

const schema = Joi.object().keys({
type: Joi.array().items(Joi.string().trim().max(128).lowercase()).required(),
user: Joi.string().hex().lowercase().length(24),
url: Joi.string()
.uri({ scheme: [/smtps?/, /https?/], allowRelative: false, relativeOnly: false })
.required(),
sess: sessSchema,
ip: sessIPSchema
const { pathParams, requestBody, queryParams } = req.route.spec.validationObjs;

const schema = Joi.object({
...pathParams,
...requestBody,
...queryParams
});

const result = schema.validate(req.params, {
Expand Down Expand Up @@ -240,14 +312,34 @@ module.exports = (db, server) => {
);

server.del(
'/webhooks/:webhook',
{
path: '/webhooks/:webhook',
tags: ['Webhooks'],
summary: 'Delete a webhook',
validationObjs: {
requestBody: {},
queryParams: {
sess: sessSchema,
ip: sessIPSchema
},
pathParams: { webhook: Joi.string().hex().lowercase().length(24).required().description('ID of the Webhook') },
response: {
200: {
description: 'Success',
model: Joi.object({ success: successRes })
}
}
}
},
tools.responseWrapper(async (req, res) => {
res.charSet('utf-8');

const schema = Joi.object().keys({
webhook: Joi.string().hex().lowercase().length(24).required(),
sess: sessSchema,
ip: sessIPSchema
const { pathParams, requestBody, queryParams } = req.route.spec.validationObjs;

const schema = Joi.object({
...pathParams,
...requestBody,
...queryParams
});

const result = schema.validate(req.params, {
Expand Down