user-request-spec.ts

/**
 *  SudoSOS back-end API service.
 *  Copyright (C) 2024  Study association GEWIS
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as published
 *  by the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 *  @license
 */

/**
 * This is the module page of the user-request-spec.
 *
 * @module internal/spec/user-request-spec
 */

import {
  Specification, toFail, toPass, validateSpecification, ValidationError,
} from '../../../helpers/specification-validation';
import { maxLength, nonZeroString } from './string-spec';
import { UserType } from '../../../entity/user/user';
import { INVALID_USER_TYPE } from './validation-errors';
import validator from 'validator';
import BaseUserRequest, { CreateUserRequest } from '../user-request';

/**
 * Most names cannot be '' or longer than 64.
 */
const nameSpec: () => Specification<string, ValidationError> = () => [
  nonZeroString,
  maxLength(64),
];

function validEmail(mail: string) {
  if (mail === undefined) return toFail(new ValidationError('invalid e-mail'));
  if (validator.isEmail(mail)) return toPass(mail);
  else return toFail(new ValidationError('invalid e-mail'));
}

/**
 * Checks if provided type is valid
 */
function validUserType(u: CreateUserRequest) {
  if (!Object.values(UserType).includes(u.type)) {
    return toFail(INVALID_USER_TYPE());
  }
  return toPass(u);
}

/**
 * When updating we check firstName and lastName.
 */
const updateUserSpec: <T extends BaseUserRequest>() => Specification<T, ValidationError> = () => [
  [nameSpec(), 'firstName', new ValidationError('Firstname: ')],
  [[validEmail], 'email', new ValidationError('E-mail: ')],
  [[maxLength(64)], 'lastName', new ValidationError('Lastname: ')],
];

/**
 * When creating a user we also check the userType
 */
const createUserSpec: () => Specification<CreateUserRequest, ValidationError> = () => [
  ...updateUserSpec<CreateUserRequest>(),
  validUserType,
];

export async function verifyCreateUserRequest(createUserRequest: CreateUserRequest) {
  return Promise.resolve(await validateSpecification(createUserRequest, createUserSpec()));
}

export async function verifyUpdateUserRequest(createUserRequest: CreateUserRequest) {
  return Promise.resolve(await validateSpecification(createUserRequest, updateUserSpec()));
}