vr-commons 1.0.24 → 1.0.26

package/dist/utils/index.d.ts

@@ -2,4 +2,4 @@ export { checkAccountDependencies, hasActiveDependencies, } from "./account.util
 export { generateAdminToken, generatePassengerToken, generateRiderToken, verifyToken, } from "./authTokens.utils";
 export { logEvent } from "./eventLog.utils";
 export { sendSuccessResponse, sendErrorResponse } from "./response.utils";
-export { formatUserForAdmin, formatAdminProfile, isUserAdmin, isUserAdminOrSuperAdmin, isUserSuperAdmin, getAdminWithClearance, getUserById, findSecurityClearanceByRole, hashPassword, validateUniqueFields, canAdminModifyUser, generateSearchConditions, } from "./profiles.utils";
+export { formatUserProfile, formatUserListResponse, hasRole, hasPermission, hasAnyPermission, hasAllPermissions, canModifyAccount, isAccountAccessible, getUserById, getUsersByRole, findSecurityClearanceByRole, generateUserSearchConditions, generateEventSearchConditions, getSortOrder, generateJacketId, validateUniqueFields, validatePassword, hashPassword, softDeleteUser, } from "./profiles.utils";

package/dist/utils/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateSearchConditions = exports.canAdminModifyUser = exports.validateUniqueFields = exports.hashPassword = exports.findSecurityClearanceByRole = exports.getUserById = exports.getAdminWithClearance = exports.isUserSuperAdmin = exports.isUserAdminOrSuperAdmin = exports.isUserAdmin = exports.formatAdminProfile = exports.formatUserForAdmin = exports.sendErrorResponse = exports.sendSuccessResponse = exports.logEvent = exports.verifyToken = exports.generateRiderToken = exports.generatePassengerToken = exports.generateAdminToken = exports.hasActiveDependencies = exports.checkAccountDependencies = void 0;
+exports.softDeleteUser = exports.hashPassword = exports.validatePassword = exports.validateUniqueFields = exports.generateJacketId = exports.getSortOrder = exports.generateEventSearchConditions = exports.generateUserSearchConditions = exports.findSecurityClearanceByRole = exports.getUsersByRole = exports.getUserById = exports.isAccountAccessible = exports.canModifyAccount = exports.hasAllPermissions = exports.hasAnyPermission = exports.hasPermission = exports.hasRole = exports.formatUserListResponse = exports.formatUserProfile = exports.sendErrorResponse = exports.sendSuccessResponse = exports.logEvent = exports.verifyToken = exports.generateRiderToken = exports.generatePassengerToken = exports.generateAdminToken = exports.hasActiveDependencies = exports.checkAccountDependencies = void 0;
 var account_utils_1 = require("./account.utils");
 Object.defineProperty(exports, "checkAccountDependencies", { enumerable: true, get: function () { return account_utils_1.checkAccountDependencies; } });
 Object.defineProperty(exports, "hasActiveDependencies", { enumerable: true, get: function () { return account_utils_1.hasActiveDependencies; } });
@@ -15,15 +15,29 @@ var response_utils_1 = require("./response.utils");
 Object.defineProperty(exports, "sendSuccessResponse", { enumerable: true, get: function () { return response_utils_1.sendSuccessResponse; } });
 Object.defineProperty(exports, "sendErrorResponse", { enumerable: true, get: function () { return response_utils_1.sendErrorResponse; } });
 var profiles_utils_1 = require("./profiles.utils");
-Object.defineProperty(exports, "formatUserForAdmin", { enumerable: true, get: function () { return profiles_utils_1.formatUserForAdmin; } });
-Object.defineProperty(exports, "formatAdminProfile", { enumerable: true, get: function () { return profiles_utils_1.formatAdminProfile; } });
-Object.defineProperty(exports, "isUserAdmin", { enumerable: true, get: function () { return profiles_utils_1.isUserAdmin; } });
-Object.defineProperty(exports, "isUserAdminOrSuperAdmin", { enumerable: true, get: function () { return profiles_utils_1.isUserAdminOrSuperAdmin; } });
-Object.defineProperty(exports, "isUserSuperAdmin", { enumerable: true, get: function () { return profiles_utils_1.isUserSuperAdmin; } });
-Object.defineProperty(exports, "getAdminWithClearance", { enumerable: true, get: function () { return profiles_utils_1.getAdminWithClearance; } });
+// Formatting functions
+Object.defineProperty(exports, "formatUserProfile", { enumerable: true, get: function () { return profiles_utils_1.formatUserProfile; } });
+Object.defineProperty(exports, "formatUserListResponse", { enumerable: true, get: function () { return profiles_utils_1.formatUserListResponse; } });
+// Role check functions
+Object.defineProperty(exports, "hasRole", { enumerable: true, get: function () { return profiles_utils_1.hasRole; } });
+Object.defineProperty(exports, "hasPermission", { enumerable: true, get: function () { return profiles_utils_1.hasPermission; } });
+Object.defineProperty(exports, "hasAnyPermission", { enumerable: true, get: function () { return profiles_utils_1.hasAnyPermission; } });
+Object.defineProperty(exports, "hasAllPermissions", { enumerable: true, get: function () { return profiles_utils_1.hasAllPermissions; } });
+Object.defineProperty(exports, "canModifyAccount", { enumerable: true, get: function () { return profiles_utils_1.canModifyAccount; } });
+Object.defineProperty(exports, "isAccountAccessible", { enumerable: true, get: function () { return profiles_utils_1.isAccountAccessible; } });
+// Database query functions
 Object.defineProperty(exports, "getUserById", { enumerable: true, get: function () { return profiles_utils_1.getUserById; } });
+Object.defineProperty(exports, "getUsersByRole", { enumerable: true, get: function () { return profiles_utils_1.getUsersByRole; } });
 Object.defineProperty(exports, "findSecurityClearanceByRole", { enumerable: true, get: function () { return profiles_utils_1.findSecurityClearanceByRole; } });
-Object.defineProperty(exports, "hashPassword", { enumerable: true, get: function () { return profiles_utils_1.hashPassword; } });
+Object.defineProperty(exports, "generateUserSearchConditions", { enumerable: true, get: function () { return profiles_utils_1.generateUserSearchConditions; } });
+Object.defineProperty(exports, "generateEventSearchConditions", { enumerable: true, get: function () { return profiles_utils_1.generateEventSearchConditions; } });
+Object.defineProperty(exports, "getSortOrder", { enumerable: true, get: function () { return profiles_utils_1.getSortOrder; } });
+// Generation functions
+Object.defineProperty(exports, "generateJacketId", { enumerable: true, get: function () { return profiles_utils_1.generateJacketId; } });
+// Validation functions
 Object.defineProperty(exports, "validateUniqueFields", { enumerable: true, get: function () { return profiles_utils_1.validateUniqueFields; } });
-Object.defineProperty(exports, "canAdminModifyUser", { enumerable: true, get: function () { return profiles_utils_1.canAdminModifyUser; } });
-Object.defineProperty(exports, "generateSearchConditions", { enumerable: true, get: function () { return profiles_utils_1.generateSearchConditions; } });
+Object.defineProperty(exports, "validatePassword", { enumerable: true, get: function () { return profiles_utils_1.validatePassword; } });
+// Password functions
+Object.defineProperty(exports, "hashPassword", { enumerable: true, get: function () { return profiles_utils_1.hashPassword; } });
+// Account management functions
+Object.defineProperty(exports, "softDeleteUser", { enumerable: true, get: function () { return profiles_utils_1.softDeleteUser; } });

package/dist/utils/profiles.utils.d.ts

@@ -1,52 +1,211 @@
-import { User, SecurityClearance, UserRole } from "vr-models";
-export interface AdminUserDetailResponse {
+import { User, SecurityClearance, UserRole, Permission } from "vr-models";
+import { Transaction, WhereOptions } from "sequelize";
+export type UserType = "RIDER" | "PASSENGER" | "AGENT" | "ADMIN" | "SUPER_ADMIN";
+export interface ProfileFormatOptions {
+    includeSensitive?: boolean;
+    includeSecurity?: boolean;
+    includeFinancial?: boolean;
+    userType?: UserType;
+}
+export interface BaseUserProfile {
     id: string;
     firstName: string;
     lastName: string;
     phoneNumber: string;
     email: string | null;
     nationalId: string;
+    isActive: boolean;
+    lastLoginAt: Date | null;
+    createdAt: Date;
+}
+export interface RiderSpecificFields {
+    jacketId: string;
+    plateNumber: string | null;
+}
+export interface PassengerSpecificFields {
+    jacketId: string;
+    plateNumber: string | null;
+}
+export interface AdminSpecificFields {
     jacketId: string;
     plateNumber: string | null;
-    isActive: boolean;
     isSuspended: boolean;
     isDeactivated: boolean;
+}
+export interface SuperAdminSpecificFields extends AdminSpecificFields {
+    bannedAt: Date | null;
+    banReason: string | null;
+    suspendedAt: Date | null;
+    suspensionReason: string | null;
     deactivatedAt: Date | null;
-    lastLoginAt: Date | null;
-    createdAt: Date;
-    role?: string;
-    level?: number;
-    permissions: string[];
+    securityClearanceId: string;
 }
-export interface AdminProfileResponse {
-    id: string;
-    firstName: string;
-    lastName: string;
-    phoneNumber: string;
-    email: string | null;
-    nationalId: string;
-    isActive: boolean;
-    lastLoginAt: Date | null;
-    createdAt: Date;
+export interface SecurityFields {
     role?: string;
     level?: number;
-    permissions: string[];
-}
-export declare const formatUserForAdmin: (user: User) => AdminUserDetailResponse;
-export declare const formatAdminProfile: (user: User) => AdminProfileResponse;
-export declare const isUserAdmin: (user: User) => boolean;
-export declare const isUserSuperAdmin: (user: User) => boolean;
-export declare const isUserAdminOrSuperAdmin: (user: User) => boolean;
-export declare const getAdminWithClearance: (userId: string) => Promise<User | null>;
-export declare const getUserById: (userId: string) => Promise<User | null>;
-export declare const findSecurityClearanceByRole: (role: UserRole) => Promise<SecurityClearance | null>;
-export declare const hashPassword: (password: string) => Promise<string>;
-export declare const validateUniqueFields: (phoneNumber: string, nationalId: string, email?: string | null) => Promise<{
+    permissions?: string[];
+}
+export type RiderProfile = BaseUserProfile & RiderSpecificFields & Partial<SecurityFields>;
+export type PassengerProfile = BaseUserProfile & PassengerSpecificFields & Partial<SecurityFields>;
+export type AgentProfile = BaseUserProfile & Partial<SecurityFields>;
+export type AdminProfile = BaseUserProfile & AdminSpecificFields & SecurityFields;
+export type SuperAdminProfile = BaseUserProfile & SuperAdminSpecificFields & SecurityFields;
+export interface UserListResponse {
+    data: Array<RiderProfile | PassengerProfile | AgentProfile | AdminProfile | SuperAdminProfile>;
+    pagination: {
+        total: number;
+        page: number;
+        limit: number;
+        pages: number;
+    };
+}
+export interface UserSearchFilters {
+    role?: UserRole;
+    isActive?: boolean;
+    isSuspended?: boolean;
+    isBanned?: boolean;
+    isDeactivated?: boolean;
+    startDate?: string;
+    endDate?: string;
+    search?: string;
+}
+export interface EventSearchFilters {
+    action?: string;
+    entity?: string;
+    startDate?: string;
+    endDate?: string;
+}
+export interface ValidationError {
     field: string;
     message: string;
-}[]>;
-export declare const canAdminModifyUser: (admin: User, targetUser: User) => {
-    canModify: boolean;
+}
+export interface GetUsersResult {
+    users: User[];
+    total: number;
+}
+export declare const PHONE_REGEX: RegExp;
+export declare const NATIONAL_ID_REGEX: RegExp;
+export declare const JACKET_ID_REGEX: RegExp;
+export declare const JACKET_ID_PREFIX = "JKT";
+/**
+ * Format user profile based on viewer type and options
+ */
+export declare const formatUserProfile: (user: User, viewerType?: UserType, options?: ProfileFormatOptions) => RiderProfile | PassengerProfile | AgentProfile | AdminProfile | SuperAdminProfile;
+/**
+ * Format user list for response (paginated)
+ */
+export declare const formatUserListResponse: (users: User[], total: number, page: number, limit: number, viewerType?: UserType) => UserListResponse;
+/**
+ * Check if user has a specific role
+ */
+export declare const hasRole: (user: User, role: UserRole | UserRole[]) => boolean;
+/**
+ * Check if user has a specific permission
+ */
+export declare const hasPermission: (user: User, permission: Permission) => boolean;
+/**
+ * Check if user has any of the given permissions
+ */
+export declare const hasAnyPermission: (user: User, permissions: Permission[]) => boolean;
+/**
+ * Check if user has all of the given permissions
+ */
+export declare const hasAllPermissions: (user: User, permissions: Permission[]) => boolean;
+/**
+ * Check if account can be modified (not deactivated/suspended)
+ */
+export declare const canModifyAccount: (user: User) => boolean;
+/**
+ * Check if account is active and accessible
+ */
+export declare const isAccountAccessible: (user: User) => boolean;
+/**
+ * Get user by ID with security clearance
+ */
+export declare const getUserById: (userId: string, includeSecurity?: boolean, excludeSensitive?: boolean) => Promise<User | null>;
+/**
+ * Get users by role with optional filters
+ */
+export declare const getUsersByRole: (role: UserRole, filters?: UserSearchFilters, pagination?: {
+    page: number;
+    limit: number;
+}) => Promise<GetUsersResult>;
+/**
+ * Find security clearance by role
+ */
+export declare const findSecurityClearanceByRole: (role: UserRole, requireDefault?: boolean) => Promise<SecurityClearance | null>;
+/**
+ * Generate search conditions for user queries
+ */
+export declare const generateUserSearchConditions: (filters: UserSearchFilters) => WhereOptions;
+/**
+ * Generate search conditions for event logs
+ */
+export declare const generateEventSearchConditions: (userId: string, filters: EventSearchFilters) => WhereOptions;
+/**
+ * Get sort order for queries
+ */
+export declare const getSortOrder: (sortBy?: string, order?: string) => any[];
+/**
+ * Generate unique jacket ID
+ */
+export declare const generateJacketId: () => Promise<string>;
+/**
+ * Validate unique user fields
+ */
+export declare const validateUniqueFields: (fields: {
+    phoneNumber?: string;
+    nationalId?: string;
+    email?: string | null;
+    jacketId?: string;
+}, excludeUserId?: string) => Promise<ValidationError[]>;
+/**
+ * Validate password
+ */
+export declare const validatePassword: (plainPassword: string, hashedPassword: string | null) => Promise<boolean>;
+/**
+ * Hash password
+ */
+export declare const hashPassword: (password: string) => Promise<string>;
+/**
+ * Soft delete user
+ */
+export declare const softDeleteUser: (userId: string, options?: {
     reason?: string;
+    deletedBy?: string;
+    transaction?: Transaction;
+}) => Promise<void>;
+declare const _default: {
+    formatUserProfile: (user: User, viewerType?: UserType, options?: ProfileFormatOptions) => RiderProfile | PassengerProfile | AgentProfile | AdminProfile | SuperAdminProfile;
+    formatUserListResponse: (users: User[], total: number, page: number, limit: number, viewerType?: UserType) => UserListResponse;
+    hasRole: (user: User, role: UserRole | UserRole[]) => boolean;
+    hasPermission: (user: User, permission: Permission) => boolean;
+    hasAnyPermission: (user: User, permissions: Permission[]) => boolean;
+    hasAllPermissions: (user: User, permissions: Permission[]) => boolean;
+    canModifyAccount: (user: User) => boolean;
+    isAccountAccessible: (user: User) => boolean;
+    getUserById: (userId: string, includeSecurity?: boolean, excludeSensitive?: boolean) => Promise<User | null>;
+    getUsersByRole: (role: UserRole, filters?: UserSearchFilters, pagination?: {
+        page: number;
+        limit: number;
+    }) => Promise<GetUsersResult>;
+    findSecurityClearanceByRole: (role: UserRole, requireDefault?: boolean) => Promise<SecurityClearance | null>;
+    generateUserSearchConditions: (filters: UserSearchFilters) => WhereOptions;
+    generateEventSearchConditions: (userId: string, filters: EventSearchFilters) => WhereOptions;
+    getSortOrder: (sortBy?: string, order?: string) => any[];
+    generateJacketId: () => Promise<string>;
+    validateUniqueFields: (fields: {
+        phoneNumber?: string;
+        nationalId?: string;
+        email?: string | null;
+        jacketId?: string;
+    }, excludeUserId?: string) => Promise<ValidationError[]>;
+    validatePassword: (plainPassword: string, hashedPassword: string | null) => Promise<boolean>;
+    hashPassword: (password: string) => Promise<string>;
+    softDeleteUser: (userId: string, options?: {
+        reason?: string;
+        deletedBy?: string;
+        transaction?: Transaction;
+    }) => Promise<void>;
 };
-export declare const generateSearchConditions: (role?: UserRole, isActive?: boolean, search?: string) => any;
+export default _default;