misskey/src/api/endpoints/app/name_id/available.ts

'use strict';

/**
 * Module dependencies
 */
import it from '../../../it';
import App from '../../../models/app';
import { isValidNameId } from '../../../models/app';

/**
 * @swagger
 * /app/name_id/available:
 *   post:
 *     summary: Check available name_id on creation an application
 *     parameters:
 *       -
 *         name: name_id
 *         description: Application unique name
 *         in: formData
 *         required: true
 *         type: string
 *
 *     responses:
 *       200:
 *         description: Success
 *         schema:
 *           type: object
 *           properties:
 *             available:
 *               description: Whether name_id is available
 *               type: boolean
 *
 *       default:
 *         description: Failed
 *         schema:
 *           $ref: "#/definitions/Error"
 */

/**
 * Check available name_id of app
 *
 * @param {any} params
 * @return {Promise<any>}
 */
module.exports = async (params) =>
	new Promise(async (res, rej) =>
{
	// Get 'name_id' parameter
	const [nameId, nameIdErr] = it(params.name_id).expect.string().required().validate(isValidNameId).qed();
	if (nameIdErr) return rej('invalid name_id param');

	// Get exist
	const exist = await App
		.count({
			name_id_lower: nameId.toLowerCase()
		}, {
			limit: 1
		});

	// Reply
	res({
		available: exist === 0
	});
});