@tc-libs/user 0.43.0 → 0.45.0

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@tc-libs/user",
-  "version": "0.43.0",
+  "version": "0.45.0",
   "dependencies": {
     "tslib": "^2.3.0",
-    "@tc-libs/authentication": "0.43.0",
-    "@tc-libs/service": "0.43.0",
-    "@tc-libs/database": "0.43.0",
+    "@tc-libs/authentication": "0.45.0",
+    "@tc-libs/service": "0.45.0",
+    "@tc-libs/database": "0.45.0",
     "@nestjs/common": "^10.0.2"
   },
   "type": "commonjs",

package/src/interfaces/services/user.admin.service.interface.d.ts

@@ -1,6 +1,29 @@
 import { IBaseUser } from '../user.base.interface';
 import { IUserService } from './user.base.service.interface';
+/**
+ * Interface representing the administrative services for user management.
+ * Extends the basic user service interface.
+ */
 export interface IUserAdminService extends IUserService {
+    /**
+     * Toggles the confirmation status of a user.
+     *
+     * @param user - The user whose confirmation status is to be toggled.
+     * @returns A promise that resolves to a boolean indicating the success of the operation.
+     */
     toggleConfirm(user: IBaseUser): Promise<boolean>;
-    toggleBlocked(user: IBaseUser): Promise<boolean>;
+    /**
+     * Blocks a user.
+     *
+     * @param user - The user to be blocked.
+     * @returns A promise that resolves to the blocked user.
+     */
+    blocked(user: IBaseUser): Promise<IBaseUser>;
+    /**
+     * Unblocks a user.
+     *
+     * @param user - The user to be unblocked.
+     * @returns A promise that resolves to the unblocked user.
+     */
+    unblocked(user: IBaseUser): Promise<IBaseUser>;
 }

package/src/interfaces/services/user.auth.service.interface.d.ts

@@ -1,21 +1,66 @@
 import { IBaseUser } from '../user.base.interface';
 import { IUserPayloadSerialization } from '../serializations/user.payload.serialization.interface';
 import { IUserService } from './user.base.service.interface';
+/**
+ * Interface representing the user authentication service.
+ * Extends the IUserService interface.
+ */
 export interface IUserAuthService extends IUserService {
+    /**
+     * Serializes the payload data.
+     * @param data - The data to be serialized.
+     * @returns The serialized user payload.
+     */
     payloadSerialization(data: any): IUserPayloadSerialization;
+    /**
+     * Signs in a user with the provided credentials.
+     * @param email - The email of the user.
+     * @param password - The password of the user.
+     * @param rememberMe - Whether to remember the user for future sessions.
+     * @param ip - The IP address of the user.
+     * @param ua - The user agent of the user.
+     * @returns A promise that resolves to an object containing token information.
+     */
     signin(email: string, password: string, rememberMe: boolean, ip: string, ua: string): Promise<{
         tokenType: string;
         expiresIn: number;
         accessToken: string;
         refreshToken: string;
     }>;
+    /**
+     * Refreshes the authentication token for a user.
+     * @param user - The user object.
+     * @param refreshToken - The refresh token.
+     * @param rememberMe - Whether to remember the user for future sessions.
+     * @param loginDate - The date of the login.
+     * @returns A promise that resolves to an object containing token information.
+     */
     refreshToken(user: IBaseUser, refreshToken: string, rememberMe: boolean, loginDate: Date): Promise<{
         tokenType: string;
         expiresIn: number;
         accessToken: string;
         refreshToken: string;
     }>;
+    /**
+     * Signs up a new user with the provided information.
+     * @param body - The signup information.
+     * @param forceConfirmed - Whether to force the user to be confirmed.
+     * @param forceRole - The role to be assigned to the user, if any.
+     * @returns A promise that resolves to the signup result.
+     */
     signup(body: any, forceConfirmed: boolean, forceRole: string | null): Promise<any>;
+    /**
+     * Increases the password attempt count for a user.
+     * @param userId - The ID of the user.
+     * @returns A promise that resolves when the operation is complete.
+     */
     increasePasswordAttempt(userId: string): Promise<void>;
+    /**
+     * Updates the login data after a successful signin.
+     * @param userId - The ID of the user.
+     * @param ip - The IP address of the user.
+     * @param ua - The user agent of the user.
+     * @returns A promise that resolves when the operation is complete.
+     */
     updateLoginDataAfterSignin(userId: string, ip: string, ua: string): Promise<void>;
 }

package/src/interfaces/services/user.base.service.interface.d.ts

@@ -1,11 +1,45 @@
 import { IService } from '@tc-libs/service';
 import { IBaseUser, IUserBirthday } from '../user.base.interface';
+/**
+ * Interface representing the user service.
+ * Extends the generic IService interface with IBaseUser as the type parameter.
+ */
 export interface IUserService extends IService<IBaseUser> {
+    /**
+     * Finds a user by their email address.
+     *
+     * @param email - The email address of the user to find.
+     * @returns A promise that resolves to the found user.
+     */
     findByEmail(email: string): Promise<IBaseUser>;
+    /**
+     * Computes the birthday details of a user.
+     *
+     * @param day - The day of the month.
+     * @param month - The month of the year.
+     * @param year - The year.
+     * @returns An object representing the user's birthday.
+     */
     computeBDay(day: number, month: number, year: number): IUserBirthday;
-    active(repository: IBaseUser): Promise<IBaseUser>;
-    inactive(repository: IBaseUser): Promise<IBaseUser>;
-    blocked(repository: IBaseUser): Promise<IBaseUser>;
-    unblocked(repository: IBaseUser): Promise<IBaseUser>;
-    joinWithRole(repository: IBaseUser): Promise<IBaseUser>;
+    /**
+     * Marks a user as inactive.
+     *
+     * @param user - The user to mark as inactive.
+     * @returns A promise that resolves to the updated user.
+     */
+    inactive(user: IBaseUser): Promise<IBaseUser>;
+    /**
+     * Marks a user as active.
+     *
+     * @param user - The user to mark as active.
+     * @returns A promise that resolves to the updated user.
+     */
+    active(user: IBaseUser): Promise<IBaseUser>;
+    /**
+     * Joins a user with their role.
+     *
+     * @param user - The user to join with a role.
+     * @returns A promise that resolves to the updated user.
+     */
+    joinWithRole(user: IBaseUser): Promise<IBaseUser>;
 }

package/src/interfaces/services/user.confirm.service.interface.d.ts

@@ -1,9 +1,38 @@
 import { IUserConfirmResendSerialization, IUserConfirmSerialization } from '../serializations/user.confirm.serialization.interface';
 import { IBaseUser } from '../user.base.interface';
 import { IUserService } from './user.base.service.interface';
+/**
+ * Interface representing the user confirmation service.
+ * Extends the base user service interface.
+ */
 export interface IUserConfirmService extends IUserService {
+    /**
+     * Resets the confirmation code for a given email.
+     *
+     * @param email - The email address for which to reset the confirmation code.
+     * @returns A promise that resolves to the new confirmation code as a string.
+     */
     resetConfirmCode(email: string): Promise<string>;
+    /**
+     * Resends the confirmation details to the user.
+     *
+     * @param user - The user object containing the necessary information.
+     * @returns A promise that resolves to the serialization of the resend confirmation response.
+     */
     resendConfirm(user: IBaseUser): Promise<IUserConfirmResendSerialization>;
+    /**
+     * Retrieves a user by their email and confirmation code.
+     *
+     * @param email - The email address of the user.
+     * @param uuid - The confirmation code associated with the user.
+     * @returns A promise that resolves to the base user object.
+     */
     getUserByEmailAndConfirmCode(email: string, uuid: string): Promise<IBaseUser>;
+    /**
+     * Confirms the user.
+     *
+     * @param user - The user object to be confirmed.
+     * @returns A promise that resolves to the serialization of the confirmation response.
+     */
     confirm(user: IBaseUser): Promise<IUserConfirmSerialization>;
 }

package/src/interfaces/services/user.reset-password.service.interface.d.ts

@@ -2,8 +2,31 @@ import { IUserResetPasswordDto } from '../dtos/user.reset-password.dto.interface
 import { IUserResetPasswordConfirmSerialization, IUserResetPasswordSerialization } from '../serializations/user.reset-password.serialization.interface';
 import { IBaseUser } from '../user.base.interface';
 import { IUserService } from './user.base.service.interface';
+/**
+ * Interface representing the user reset password service.
+ * Extends the base user service interface.
+ */
 export interface IUserResetPasswordService extends IUserService {
+    /**
+     * Retrieves a user by their email and reset confirmation code.
+     *
+     * @param email - The email of the user.
+     * @param uuid - The reset confirmation code.
+     * @returns A promise that resolves to the base user object.
+     */
     getUserByEmailAndResetConfirmCode(email: string, uuid: string): Promise<IBaseUser>;
+    /**
+     * Resets the user's password.
+     *
+     * @param resetPasswordDto - The data transfer object containing the reset password information.
+     * @returns A promise that resolves to the reset password serialization object.
+     */
     resetPassword(resetPasswordDto: IUserResetPasswordDto): Promise<IUserResetPasswordSerialization>;
+    /**
+     * Confirms the user's password reset.
+     *
+     * @param user - The base user object.
+     * @returns A promise that resolves to the reset password confirmation serialization object.
+     */
     confirmResetPassword(user: IBaseUser): Promise<IUserResetPasswordConfirmSerialization>;
 }