Sharkey/src/server/api/endpoints/app/show.ts

67 lines
1.7 KiB
TypeScript
Raw Normal View History

2018-04-24 12:13:06 +03:00
import $ from 'cafy'; import ID from '../../../../cafy-id';
2018-06-18 03:54:53 +03:00
import App, { pack, IApp } from '../../../../models/app';
import { ILocalUser } from '../../../../models/user';
2016-12-29 00:49:51 +02:00
2017-01-06 09:16:53 +02:00
/**
* @swagger
* /app/show:
2018-04-07 20:30:37 +03:00
* note:
2017-01-06 09:16:53 +02:00
* summary: Show an application's information
2018-03-29 08:48:47 +03:00
* description: Require appId or nameId
2017-01-06 09:16:53 +02:00
* parameters:
* -
2018-03-29 08:48:47 +03:00
* name: appId
2017-01-06 09:16:53 +02:00
* description: Application ID
* in: formData
* type: string
* -
2018-03-29 08:48:47 +03:00
* name: nameId
2017-01-06 09:16:53 +02:00
* description: Application unique name
* in: formData
* type: string
2017-03-01 10:37:01 +02:00
*
2017-01-06 09:16:53 +02:00
* responses:
* 200:
* description: Success
* schema:
* $ref: "#/definitions/Application"
2017-03-01 10:37:01 +02:00
*
2017-01-06 09:16:53 +02:00
* default:
* description: Failed
* schema:
* $ref: "#/definitions/Error"
*/
2016-12-29 00:49:51 +02:00
/**
* Show an app
*/
2018-06-18 03:54:53 +03:00
module.exports = (params: any, user: ILocalUser, app: IApp) => new Promise(async (res, rej) => {
const isSecure = user != null && app == null;
2018-03-29 08:48:47 +03:00
// Get 'appId' parameter
2018-07-05 17:36:07 +03:00
const [appId, appIdErr] = $.type(ID).optional.get(params.appId);
2018-03-29 08:48:47 +03:00
if (appIdErr) return rej('invalid appId param');
2016-12-29 00:49:51 +02:00
2018-03-29 08:48:47 +03:00
// Get 'nameId' parameter
2018-07-05 17:36:07 +03:00
const [nameId, nameIdErr] = $.str.optional.get(params.nameId);
2018-03-29 08:48:47 +03:00
if (nameIdErr) return rej('invalid nameId param');
2016-12-29 00:49:51 +02:00
2017-03-03 13:28:42 +02:00
if (appId === undefined && nameId === undefined) {
2018-03-29 08:48:47 +03:00
return rej('appId or nameId is required');
2016-12-29 00:49:51 +02:00
}
// Lookup app
const ap = appId !== undefined
2017-03-03 12:48:00 +02:00
? await App.findOne({ _id: appId })
2018-03-29 08:48:47 +03:00
: await App.findOne({ nameIdLower: nameId.toLowerCase() });
2016-12-29 00:49:51 +02:00
if (ap === null) {
2016-12-29 00:49:51 +02:00
return rej('app not found');
}
// Send response
res(await pack(ap, user, {
includeSecret: isSecure && ap.userId.equals(user._id)
2016-12-29 00:49:51 +02:00
}));
});