Add project files.

This commit is contained in:
Sergio Matias Urquin
2025-04-29 18:55:44 -06:00
commit c34987797a
46 changed files with 3697 additions and 0 deletions

View File

@@ -0,0 +1,64 @@
// ***********************************************************************
// <copyright file="IModuleService.cs">
// Heath
// </copyright>
// ***********************************************************************
using Core.Cerberos.Adapters;
using Core.Cerberos.Adapters.Common.Enums;
using Core.Cerberos.Domain.Contexts.Onboarding.Request;
namespace Core.Cerberos.Provider.Contracts
{
public interface IModuleService
{
/// <summary>
/// Creates a new Module.
/// </summary>
/// <param name="entity">The Module to be created.</param>
/// <returns>A <see cref="{Task{ModuleAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<ModuleAdapter> CreateModuleService(ModuleRequest newModule);
/// <summary>
/// Gets an Module by identifier.
/// </summary>
/// <param name="id">The Module identifier.</param>
/// <returns>A <see cref="{Task{ModuleAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<ModuleAdapter> GetModuleByIdService(string id);
/// <summary>
/// Gets all the roles.
/// </summary>
/// <returns>A <see cref="{Task{IEnumerbale{ModuleAdapter}}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<IEnumerable<ModuleAdapter>> GetAllModulesService();
/// <summary>
/// Gets all the permissions by permissions identifier list.
/// </summary>
/// <param name="permissions">The list of permissions identifiers.</param>
/// <returns>A <see cref="Task{IEnumerable{ModuleAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<IEnumerable<ModuleAdapter>> GetAllModulesByListService(string[] permissions);
/// <summary>
/// Changes the status of the permission.
/// </summary>
/// <param name="id">The permission identifier.</param>
/// <param name="newStatus">The new status of the permission.</param>
/// <returns>The <see cref="ModuleAdapter"/> updated entity.</returns>
/// <returns>A <see cref="{Task{ModuleAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<ModuleAdapter> ChangeModuleStatusService(string id, StatusEnum newStatus);
/// <summary>
/// Updates a Module by id.
/// </summary>
/// <param name="entity">The Module to be updated.</param>
/// <param name="id">The Module identifier.</param>
/// <returns>A <see cref="{Task{ModuleAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<ModuleAdapter> UpdateModuleService(ModuleAdapter entity, string id);
}
}

View File

@@ -0,0 +1,64 @@
// ***********************************************************************
// <copyright file="IPermissionService.cs">
// Heath
// </copyright>
// ***********************************************************************
using Core.Cerberos.Adapters;
using Core.Cerberos.Adapters.Common.Enums;
using Core.Cerberos.Domain.Contexts.Onboarding.Request;
namespace Core.Cerberos.Provider.Contracts
{
public interface IPermissionService
{
/// <summary>
/// Creates a new Permission.
/// </summary>
/// <param name="entity">The Permission to be created.</param>
/// <returns>A <see cref="{Task{PermissionAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<PermissionAdapter> CreatePermissionService(PermissionRequest newPermission);
/// <summary>
/// Gets an Permission by identifier.
/// </summary>
/// <param name="id">The Permission identifier.</param>
/// <returns>A <see cref="{Task{PermissionAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<PermissionAdapter> GetPermissionByIdService(string id);
/// <summary>
/// Gets all the roles.
/// </summary>
/// <returns>A <see cref="{Task{IEnumerbale{PermissionAdapter}}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<IEnumerable<PermissionAdapter>> GetAllPermissionsService();
/// <summary>
/// Gets all the permissions by permissions identifier list.
/// </summary>
/// <param name="permissions">The list of permissions identifiers.</param>
/// <returns>A <see cref="Task{IEnumerable{PermissionAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<IEnumerable<PermissionAdapter>> GetAllPermissionsByListService(string[] permissions);
/// <summary>
/// Changes the status of the permission.
/// </summary>
/// <param name="id">The permission identifier.</param>
/// <param name="newStatus">The new status of the permission.</param>
/// <returns>The <see cref="PermissionAdapter"/> updated entity.</returns>
/// <returns>A <see cref="{Task{PermissionAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<PermissionAdapter> ChangePermissionStatusService(string id, StatusEnum newStatus);
/// <summary>
/// Updates a Permission by id.
/// </summary>
/// <param name="entity">The Permission to be updated.</param>
/// <param name="id">The Permission identifier.</param>
/// <returns>A <see cref="{Task{PermissionAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<PermissionAdapter> UpdatePermissionService(PermissionAdapter entity, string id);
}
}

View File

@@ -0,0 +1,72 @@
// ***********************************************************************
// <copyright file="IRoleService.cs">
// Heath
// </copyright>
// ***********************************************************************
using Core.Cerberos.Adapters;
using Core.Cerberos.Adapters.Common.Enums;
using Core.Cerberos.Domain.Contexts.Onboarding.Request;
namespace Core.Cerberos.Provider.Contracts
{
public interface IRoleService
{
/// <summary>
/// Creates a new Role.
/// </summary>
/// <param name="entity">The Role to be created.</param>
/// <returns>A <see cref="{Task{RoleAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<RoleAdapter> CreateRoleService(RoleRequest newRole);
/// <summary>
/// Gets an Role by identifier.
/// </summary>
/// <param name="id">The Role identifier.</param>
/// <returns>A <see cref="{Task{RoleAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<RoleAdapter> GetRoleByIdService(string id);
/// <summary>
/// Gets all the roles.
/// </summary>
/// <returns>A <see cref="{Task{IEnumerbale{RoleAdapter}}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<IEnumerable<RoleAdapter>> GetAllRolesService();
/// <summary>
/// Changes the status of the role.
/// </summary>
/// <param name="id">The role identifier.</param>
/// <param name="newStatus">The new status of the role.</param>
/// <returns>The <see cref="RoleAdapter"/> updated entity.</returns>
/// <returns>A <see cref="{Task{RoleAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<RoleAdapter> ChangeRoleStatusService(string id, StatusEnum newStatus);
/// <summary>
/// Updates a Role by id.
/// </summary>
/// <param name="entity">The Role to be updated.</param>
/// <param name="id">The Role identifier.</param>
/// <returns>A <see cref="{Task{RoleAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<RoleAdapter> UpdateRoleService(RoleAdapter entity, string id);
/// <summary>
/// Adds an application to the role's list of applications.
/// </summary>
/// <param name="roleId">The identifier of the role to which the application will be added.</param>
/// <param name="application">The application enum value to add.</param>
/// <returns>A <see cref="{Task{RoleAdapter}}"/> representing the asynchronous operation, with the updated role object.</returns>
Task<RoleAdapter> AddApplicationToRoleService(string roleId, ApplicationsEnum application);
/// <summary>
/// Removes an application from the role's list of applications.
/// </summary>
/// <param name="roleId">The identifier of the role from which the application will be removed.</param>
/// <param name="application">The application enum value to remove.</param>
/// <returns>A <see cref="{Task{RoleAdapter}}"/> representing the asynchronous operation, with the updated role object.</returns>
Task<RoleAdapter> RemoveApplicationFromRoleService(string roleId, ApplicationsEnum application);
}
}

View File

@@ -0,0 +1,143 @@
// ***********************************************************************
// <copyright file="IUserService.cs">
// Heath
// </copyright>
// ***********************************************************************
using Core.Blueprint.Storage.Adapters;
using Core.Cerberos.Adapters;
using Core.Cerberos.Adapters.Common.Enums;
using Core.Cerberos.Domain.Contexts.Onboarding.Request;
namespace Core.Cerberos.Provider.Contracts
{
public interface IUserService
{
/// <summary>
/// Creates a new User.
/// </summary>
/// <param name="entity">The User to be created.</param>
/// <returns>A <see cref="{Task{UserAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<UserAdapter> CreateUserService(UserRequest newUser);
/// <summary>
/// Gets an User by identifier.
/// </summary>
/// <param name="id">The User identifier.</param>
/// <returns>A <see cref="{Task{UserAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<UserAdapter> GetUserByIdService(string id);
/// <summary>
/// Gets all the users.
/// </summary>
/// <returns>A <see cref="{Task{IEnumerable{UserAdapter}}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<IEnumerable<UserAdapter>> GetAllUsersService();
/// <summary>
/// Gets an User by email.
/// </summary>
/// <param name="email">The User email.</param>
/// <returns>A <see cref="{Task{UserAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<UserAdapter> GetUserByEmailService(string? email);
/// <summary>
/// Validates if a users exists by email.
/// </summary>
/// <param name="eamil">The User email.</param>
/// <returns>A <see cref="{Task{UserAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<UserAdapter> ValidateUserExistenceService(string? email);
/// <summary>
/// Changes the status of the user.
/// </summary>
/// <param name="id">The user identifier.</param>
/// <param name="newStatus">The new status of the user.</param>
/// <returns>A <see cref="{Task{UserAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<UserAdapter> ChangeUserStatusService(string id, StatusEnum newStatus);
/// <summary>
/// Updates a User by id.
/// </summary>
/// <param name="entity">The User to be updated.</param>
/// <param name="id">The User identifier.</param>
/// <returns>A <see cref="{Task{UserAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<UserAdapter> UpdateUserService(UserAdapter entity, string id);
/// <summary>
/// Logs in the user.
/// </summary>
/// <param name="email">The User's email.</param>
/// <returns>A <see cref="{Task{UserAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<UserAdapter?> LogInUserService(string email);
/// <summary>
/// Logs out the user's session.
/// </summary>
/// <param name="email">The User's email.</param>
/// <returns>A <see cref="{Task{UserAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<UserAdapter> LogOutUserSessionService(string email);
/// <summary>
/// Adds a company to the user's list of companies.
/// </summary>
/// <param name="userId">The identifier of the user to whom the company will be added.</param>
/// <param name="companyId">The identifier of the company to add.</param>
/// <returns>A <see cref="Task{UserAdapter}"/> representing the asynchronous operation, with the updated user object.</returns>
Task<UserAdapter> AddCompanyToUserService(string userId, string companyId);
/// <summary>
/// Removes a company from the user's list of companies.
/// </summary>
/// <param name="userId">The identifier of the user from whom the company will be removed.</param>
/// <param name="companyId">The identifier of the company to remove.</param>
/// <returns>A <see cref="Task{UserAdapter}"/> representing the asynchronous operation, with the updated user object.</returns>
Task<UserAdapter> RemoveCompanyFromUserService(string userId, string companyId);
/// <summary>
/// Adds a project to the user's list of projects.
/// </summary>
/// <param name="userId">The identifier of the user to whom the project will be added.</param>
/// <param name="projectId">The identifier of the project to add.</param>
/// <returns>A <see cref="Task{UserAdapter}"/> representing the asynchronous operation, with the updated user object.</returns>
Task<UserAdapter> AddProjectToUserService(string userId, string projectId);
/// <summary>
/// Removes a project from the user's list of projects.
/// </summary>
/// <param name="userId">The identifier of the user from whom the project will be removed.</param>
/// <param name="projectId">The identifier of the project to remove.</param>
/// <returns>A <see cref="Task{UserAdapter}"/> representing the asynchronous operation, with the updated user object.</returns>
Task<UserAdapter> RemoveProjectFromUserService(string userId, string projectId);
/// <summary>
/// Gets the token adapter for a user.
/// </summary>
/// <param name="email">The user's email.</param>
/// <returns>A <see cref="{Task{TokenAdapter}}"/> representing the asynchronous execution of the service.</returns>
Task<TokenAdapter?> GetTokenAdapter(string email);
/// <summary>
/// Get Consent Form PDF.
/// </summary>
/// <returns>A <see cref="{Task{BlobDownloadUriAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<BlobDownloadUriAdapter> GetConsentFormPDFService();
/// <summary>
/// Accept user consent form.
/// </summary>
/// <returns>A <see cref="{Task{UserAdapter}}"/> representing
/// the asynchronous execution of the service.</returns>
Task<UserAdapter?> AcceptUserConsentFormService();
}
}