@tc-libs/user 0.41.0 → 0.43.0

package/package.json

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

package/src/interfaces/serializations/user.payload.serialization.interface.d.ts

@@ -1,6 +1,6 @@
 import { ENUM_AUTH_ACCESS_FOR } from '@tc-libs/authentication';
 import { IUserGetSerialization } from './user.get.serialization.interface';
-export interface IUserPayloadSerialization extends Omit<IUserGetSerialization, 'Role' | 'role' | 'confirmation' | 'confirmed' | 'agreements' | 'notifications' | 'authProvidersts' | 'active' | 'authProviders' | 'inactiveDate' | 'blocked' | 'createdAt' | 'updatedAt'> {
+export interface IUserPayloadSerialization extends Omit<IUserGetSerialization, 'Role' | 'role' | 'confirmation' | 'flags' | 'agreements' | 'notifications' | 'authProvidersts' | 'authProviders' | 'createdAt' | 'updatedAt'> {
     rememberMe: boolean;
     accessFor: ENUM_AUTH_ACCESS_FOR;
 }

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

@@ -11,45 +11,116 @@ export declare enum AUTH_PROVIDERS {
     MI = "microsoft",
     PP = "paypal"
 }
+/**
+ * Interface representing the acceptance of a flag.
+ *
+ * @interface IFlagAcceptance
+ *
+ * @property {boolean} enabled - Indicates whether the flag is enabled.
+ * @property {Date} ts - The timestamp when the flag was accepted.
+ * @property {string} version - The version of the flag acceptance.
+ */
 export interface IFlagAcceptance {
     enabled: boolean;
     ts: Date;
     version: string;
 }
+/**
+ * Interface representing user notifications settings.
+ * @property {IFlagAcceptance} newsletter - User's acceptance of newsletter.
+ */
 export interface IUserNotifications {
     newsletter: IFlagAcceptance;
 }
+/**
+ * Interface representing user agreements.
+ *
+ * @interface IUserAgreements
+ *
+ * @property {IFlagAcceptance} terms - User's acceptance of the terms and conditions.
+ * @property {IFlagAcceptance} privacy - User's acceptance of the privacy policy.
+ * @property {IFlagAcceptance} commercial - User's acceptance of commercial communications.
+ */
 export interface IUserAgreements {
     terms: IFlagAcceptance;
     privacy: IFlagAcceptance;
     commercial: IFlagAcceptance;
 }
 export interface IUserBirthday {
-    day: number;
-    month: number;
-    year: number;
-    date: Date;
+    day?: number;
+    month?: number;
+    year?: number;
+    date?: Date;
 }
+/**
+ * Interface representing the structure of user reset password details.
+ *
+ * @interface IUserResetPassword
+ *
+ * @property {string} [code] - The reset password code.
+ * @property {string} [tmpPassword] - The temporary password assigned to the user.
+ * @property {Date} [ts] - The timestamp when the reset password was requested.
+ */
 export interface IUserResetPassword {
-    code: string;
-    tmpPassword: string;
-    ts: Date;
+    code?: string;
+    tmpPassword?: string;
+    ts?: Date;
 }
+/**
+ * Interface representing the history of user passwords.
+ *
+ * @interface IUserPasswordHistory
+ *
+ * @property {string} password - The user's previous password.
+ * @property {Date} ts - The timestamp when the password was changed.
+ */
 export interface IUserPasswordHistory {
     password: string;
     ts: Date;
 }
+/**
+ * Interface representing the structure of user email confirmation details.
+ * @interface IUserEmailConfirmation
+ * @property {string} [code] - The confirmation code.
+ * @property {Date} [ts] - The timestamp of the confirmation code.
+ */
 export interface IUserEmailConfirmation {
     code?: string;
     ts?: Date;
 }
+/**
+ * Interface representing user login information.
+ *
+ * @interface IUserLoginInfo
+ *
+ * @property {number} attempt - The number of unsuccessful login attempts made by the user.
+ * @property {number} count - The count of successful logins.
+ * @property {string} [ip] - The IP address from which the user attempted to log in.
+ * @property {string} [ua] - The user agent string of the browser or device used for login.
+ * @property {Date} [lastLogin] - The date and time of the last successful login.
+ */
 export interface IUserLoginInfo {
     attempt: number;
     count: number;
-    ip: string;
-    ua: string;
-    lastLogin: Date;
+    ip?: string;
+    ua?: string;
+    lastLogin?: Date;
 }
+/**
+ * Interface representing a user's social media information.
+ *
+ * @interface IUserSocialInfo
+ *
+ * @property {string} facebookId - The user's Facebook ID.
+ * @property {string} twitterId - The user's Twitter ID.
+ * @property {string} githubId - The user's GitHub ID.
+ * @property {string} linkedinId - The user's LinkedIn ID.
+ * @property {string} amazonId - The user's Amazon ID.
+ * @property {string} googleId - The user's Google ID.
+ * @property {string} bitbucketId - The user's Bitbucket ID.
+ * @property {string} microsoftId - The user's Microsoft ID.
+ * @property {string} paypalId - The user's PayPal ID.
+ */
 export interface IUserSocialInfo {
     facebookId: string;
     twitterId: string;
@@ -61,6 +132,46 @@ export interface IUserSocialInfo {
     microsoftId: string;
     paypalId: string;
 }
+/**
+ * Interface representing the flags associated with a user.
+ *
+ * @property {boolean} confirmed - Indicates if the user has confirmed their account by the email.
+ * @property {boolean} [iddqd] - Optional flag for a special status (e.g., god mode).
+ * @property {boolean} blocked - Indicates if the user is blocked by admin.
+ * @property {Date} [blockedDate] - Optional date when the user was blocked.
+ * @property {boolean} active - Indicates if the user is inactivated by itself.
+ * @property {Date} [inactiveDate] - Optional date when the user became inactivated by itself.
+ */
+export interface IUserFlags {
+    confirmed: boolean;
+    iddqd?: boolean;
+    blocked: boolean;
+    blockedDate?: Date;
+    active: boolean;
+    inactiveDate?: Date;
+}
+/**
+ * Interface representing the base structure of a user entity.
+ *
+ * @extends IDatabaseMongoBaseEntityAbstract
+ *
+ * @property {string} email - The email address of the user.
+ * @property {string} password - The password of the user.
+ * @property {string} role - The role assigned to the user.
+ * @property {string} [firstName] - The first name of the user.
+ * @property {string} [lastName] - The last name of the user.
+ * @property {string} [lang] - The preferred language of the user.
+ * @property {IUserFlags} flags - The flags associated with the user.
+ * @property {IUserResetPassword} [resetPassword] - Information related to password reset.
+ * @property {IUserEmailConfirmation} confirmation - Information related to email confirmation.
+ * @property {IUserPasswordHistory[]} [passwordHistory] - History of the user's passwords.
+ * @property {IUserLoginInfo} [login] - Information related to user login attempts.
+ * @property {IUserSocialInfo} [social] - Information related to user's social media accounts.
+ * @property {IUserAgreements} agreements - User's acceptance of various agreements.
+ * @property {IUserNotifications} notifications - User's notification preferences.
+ * @property {IUserBirthday} [birthday] - User's birthday information.
+ * @property {string[]} authProviders - List of authentication providers associated with the user.
+ */
 export interface IBaseUser extends IDatabaseMongoBaseEntityAbstract {
     email: string;
     password: string;
@@ -68,12 +179,7 @@ export interface IBaseUser extends IDatabaseMongoBaseEntityAbstract {
     firstName?: string;
     lastName?: string;
     lang?: string;
-    iddqd?: boolean;
-    confirmed: boolean;
-    blocked: boolean;
-    blockedDate?: Date;
-    active: boolean;
-    inactiveDate?: Date;
+    flags: IUserFlags;
     resetPassword?: IUserResetPassword;
     confirmation: IUserEmailConfirmation;
     passwordHistory?: IUserPasswordHistory[];