@platform-modules/foreign-ministry 1.3.40 → 1.3.41

package/src/models/GatePassRequestsModel.ts

@@ -0,0 +1,139 @@
+import { Column, Entity } from "typeorm";
+import { BaseModel } from './BaseModel';
+
+/**
+ * Gate Pass Request Status Enum
+ */
+export enum GatePassRequestStatus {
+  PENDING = "Pending",
+  APPROVED = "Approved",
+  REJECTED = "Rejected",
+  CANCELLED = "Cancelled",
+  IN_PROGRESS = "In Progress"
+}
+
+/**
+ * Gate Pass Type Enum
+ */
+export enum GatePassType {
+  SHORT_TERM = "Short-term",
+  LONG_TERM = "Long-term"
+}
+
+/**
+ * Main Gate Pass Request Table (FM022)
+ * This table stores the primary gate pass request data
+ * Employees request gate passes for visitors
+ */
+@Entity({ name: 'gate_pass_requests' })
+export class GatePassRequests extends BaseModel {
+  
+  // User and Department Information
+  @Column({ type: 'int', nullable: false })
+  user_id: number; // Employee who is requesting
+
+  @Column({ type: 'int', nullable: true })
+  req_user_department_id: number | null;
+
+  @Column({ type: 'int', nullable: true })
+  req_user_section_id: number | null;
+
+  @Column({ type: 'int', nullable: true })
+  service_id: number | null;
+
+  @Column({ type: 'int', nullable: true })
+  sub_service_id: number | null;
+
+  // Request Status and Workflow
+  @Column({ type: 'enum', enum: GatePassRequestStatus, default: GatePassRequestStatus.PENDING, nullable: false })
+  status: GatePassRequestStatus;
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  workflow_execution_id: string | null;
+
+  // Gate Pass Request Fields (from requirements)
+  @Column({ type: 'date', nullable: true })
+  date: Date | null; // التاريخ (Date)
+
+  @Column({ type: 'int', nullable: true })
+  department_id: number | null; // الدائرة (Department)
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  serial_number: string | null; // الرقم التسلسلي (Serial Number)
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  office_number: string | null; // رقم المكتب (Office Number)
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  visiting_department: string | null; // قسم الزيارة (Visiting Department) - Auto filled
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  person_to_be_interviewed: string | null; // الشخص المطلوب مقابلته (Person to be Interviewed)
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  vehicle_type_and_color: string | null; // نوع المركبة ولونها (Vehicle Type and Color)
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  plate_number_and_code: string | null; // رقم اللوحة والرمز (Plate Number and Code)
+
+  @Column({ type: 'text', nullable: true })
+  purpose_of_entry: string | null; // الغرض من الدخول (Purpose of Entry)
+
+  @Column({ type: 'date', nullable: true })
+  from_date: Date | null; // من (From)
+
+  @Column({ type: 'date', nullable: true })
+  to_date: Date | null; // الى (To)
+
+  @Column({ type: 'enum', enum: GatePassType, nullable: true })
+  gate_pass_type: GatePassType | null; // نوع ممر البوابة (Gate Pass Type) - Short Term / Long Term
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  visiting_person_in_department: string | null; // زائر في القسم (Visiting Person in Department)
+
+  constructor(
+    user_id: number,
+    req_user_department_id: number | null,
+    req_user_section_id: number | null,
+    service_id: number | null,
+    sub_service_id: number | null,
+    status: GatePassRequestStatus,
+    workflow_execution_id: string | null,
+    date: Date | null,
+    department_id: number | null,
+    serial_number: string | null,
+    office_number: string | null,
+    visiting_department: string | null,
+    person_to_be_interviewed: string | null,
+    vehicle_type_and_color: string | null,
+    plate_number_and_code: string | null,
+    purpose_of_entry: string | null,
+    from_date: Date | null,
+    to_date: Date | null,
+    gate_pass_type: GatePassType | null,
+    visiting_person_in_department: string | null
+  ) {
+    super();
+    this.user_id = user_id;
+    this.req_user_department_id = req_user_department_id;
+    this.req_user_section_id = req_user_section_id;
+    this.service_id = service_id;
+    this.sub_service_id = sub_service_id;
+    this.status = status;
+    this.workflow_execution_id = workflow_execution_id;
+    this.date = date;
+    this.department_id = department_id;
+    this.serial_number = serial_number;
+    this.office_number = office_number;
+    this.visiting_department = visiting_department;
+    this.person_to_be_interviewed = person_to_be_interviewed;
+    this.vehicle_type_and_color = vehicle_type_and_color;
+    this.plate_number_and_code = plate_number_and_code;
+    this.purpose_of_entry = purpose_of_entry;
+    this.from_date = from_date;
+    this.to_date = to_date;
+    this.gate_pass_type = gate_pass_type;
+    this.visiting_person_in_department = visiting_person_in_department;
+  }
+}
+

package/src/models/GatePassVisitorsModel.ts

@@ -0,0 +1,100 @@
+import { Column, Entity } from "typeorm";
+import { BaseModel } from './BaseModel';
+
+/**
+ * Gate Pass Visitors Table
+ * Stores visitor information for each gate pass request
+ * One request can have multiple visitors
+ */
+@Entity({ name: 'gate_pass_visitors' })
+export class GatePassVisitors extends BaseModel {
+  
+  @Column({ type: 'int', nullable: false })
+  gate_pass_request_id: number; // Foreign key to gate_pass_requests
+
+  @Column({ type: 'int', nullable: true })
+  service_id: number | null;
+
+  @Column({ type: 'int', nullable: true })
+  sub_service_id: number | null;
+
+  // Visitor Information Fields (from requirements)
+  @Column({ type: 'varchar', length: 255, nullable: false })
+  visitor_name: string; // اسم الزائر (Visitor Name)
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  visitor_id_passport_no: string | null; // رقم هوية الزائر / جواز السفر (Visitor ID / Passport No)
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  nationality: string | null; // الجنسية (Nationality)
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  job_title: string | null; // الوظيفة (The Job)
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  represented_entity: string | null; // الجهة التي يمثلها (The Represented Entity)
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  visitor_email_address: string | null; // عنوان البريد الإلكتروني للزائر (Visitor email Address)
+
+  @Column({ type: 'varchar', length: 50, nullable: true })
+  visitor_mobile_number: string | null; // رقم هاتف الزائر (Visitor Mobile Number)
+
+  @Column({ type: 'varchar', length: 500, nullable: true })
+  visitor_photo_url: string | null; // صورة الزائر (Visitor Photo) - Required for Long Term Gate pass
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  visitor_photo_file_name: string | null;
+
+  // QR Code for Gate Pass
+  @Column({ type: 'text', nullable: true })
+  qr_code_url: string | null; // QR code URL for this visitor (data URL can be 6000+ characters)
+
+  @Column({ type: 'text', nullable: true })
+  qr_code_data: string | null; // QR code data (JSON string)
+
+  // Gate Pass Generation
+  @Column({ type: 'boolean', default: false, nullable: false })
+  gate_pass_generated: boolean; // Whether gate pass has been generated
+
+  @Column({ type: 'timestamptz', nullable: true })
+  gate_pass_generated_at: Date | null; // When gate pass was generated
+
+  @Column({ type: 'boolean', default: false, nullable: false })
+  email_sent: boolean; // Whether email has been sent to visitor
+
+  @Column({ type: 'timestamptz', nullable: true })
+  email_sent_at: Date | null; // When email was sent
+
+  constructor(
+    gate_pass_request_id: number,
+    visitor_name: string,
+    service_id: number | null,
+    sub_service_id: number | null,
+    visitor_id_passport_no: string | null,
+    nationality: string | null,
+    job_title: string | null,
+    represented_entity: string | null,
+    visitor_email_address: string | null,
+    visitor_mobile_number: string | null,
+    visitor_photo_url: string | null,
+    visitor_photo_file_name: string | null
+  ) {
+    super();
+    this.gate_pass_request_id = gate_pass_request_id;
+    this.service_id = service_id;
+    this.sub_service_id = sub_service_id;
+    this.visitor_name = visitor_name;
+    this.visitor_id_passport_no = visitor_id_passport_no;
+    this.nationality = nationality;
+    this.job_title = job_title;
+    this.represented_entity = represented_entity;
+    this.visitor_email_address = visitor_email_address;
+    this.visitor_mobile_number = visitor_mobile_number;
+    this.visitor_photo_url = visitor_photo_url;
+    this.visitor_photo_file_name = visitor_photo_file_name;
+    this.gate_pass_generated = false;
+    this.email_sent = false;
+  }
+}
+

package/src/models/GatePassWorkFlowModel.ts

@@ -0,0 +1,66 @@
+import { Column, Entity } from "typeorm";
+import { BaseModel } from './BaseModel';
+
+/**
+ * Gate Pass Workflow Status Enum
+ */
+export enum GatePassWorkFlowStatus {
+  COMPLETED = "Completed",
+  NOT_YET_STARTED = "Not Yet Started",
+  PENDING = "Pending",
+  IN_PROGRESS = "In Progress"
+}
+
+/**
+ * Gate Pass Workflow Table
+ * Tracks the progress of the request through different workflow stages
+ * Provides a timeline/audit trail of the process
+ * 
+ * Workflow: Employee → Department Admin Office → Security Department
+ */
+@Entity({ name: 'gate_pass_workflows' })
+export class GatePassWorkFlow extends BaseModel {
+  
+  @Column({ type: 'int', nullable: false })
+  gate_pass_request_id: number; // Foreign key to gate_pass_requests
+
+  @Column({ type: 'int', nullable: false, default: 0 })
+  gate_pass_approval_details_id: number; // Foreign key to gate_pass_approvals
+
+  @Column({ type: 'varchar', length: 255, nullable: false })
+  content: string; // Description of the workflow step
+
+  @Column({ type: 'enum', enum: GatePassWorkFlowStatus, default: GatePassWorkFlowStatus.NOT_YET_STARTED, nullable: false })
+  status: GatePassWorkFlowStatus; // Current status of this workflow step
+
+  @Column({ type: 'integer', nullable: true })
+  user_id: number | null; // User responsible for this step
+
+  @Column({ type: 'integer', nullable: true })
+  role_id: number | null; // Role responsible for this step
+
+  @Column({ type: 'integer', nullable: true })
+  department_id: number | null; // Department involved in this step
+
+  @Column({ type: 'integer', nullable: true })
+  section_id: number | null; // Section involved in this step
+
+  @Column({ type: 'integer', nullable: false, default: 1 })
+  level: number; // Workflow level
+
+  @Column({ type: 'varchar', length: 50, nullable: true })
+  access_type: string | null; // Normal - to track workflow path
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  action_taken: string | null; // Action taken
+
+  @Column({ type: 'timestamptz', nullable: true })
+  action_date: Date | null; // Date when action was taken
+
+  @Column({ type: 'integer', nullable: true })
+  service_id: number | null;
+
+  @Column({ type: 'integer', nullable: true })
+  sub_service_id: number | null;
+}
+

package/src/models/LeaveConfigModel.ts

@@ -1,72 +1,72 @@
-import { Column, Entity } from "typeorm";
-import { BaseModel } from './BaseModel';
-
-export enum enumFrequency {
-    Monthly = 'Monthly',
-    Yearly = 'Yearly',
-}
-
-//This model is used to store the Financial Grade declaration on the Admin Side
-@Entity({ name: 'leave_configuration' })
-export class LeaveConfiguration extends BaseModel {
-
-    @Column({ type: 'varchar', nullable: true })
-    category: string;
-
-    @Column({ type: 'int', nullable: true })
-    MandC_id: number;
-
-    @Column({ type: 'int', nullable: true })
-    leave_type_id: number;
-
-    @Column({ type: 'varchar', nullable: true })
-    frequency: enumFrequency;
-
-    @Column({ type: 'varchar', nullable: true })
-    region: string;
-
-    @Column({ type: 'varchar', nullable: true })
-    country: string;
-
-    @Column({ type: 'varchar', nullable: true })
-    location: string;
-
-    @Column({ nullable: true, default: false })
-    is_carryforward: boolean;
-
-    @Column({ type: 'int', nullable: true, default: 0 })
-    carryforward_limit: number;
-
-    @Column({ type: 'date', nullable: true })
-    from_date: Date;
-
-    @Column({ type: 'date', nullable: true })
-    to_date: Date;
-
-    @Column({ type: 'varchar', nullable: true })
-    reason: string;
-
-    @Column({ type: 'int', nullable: true })
-    emergency_balance_days: number | null;
-
-    @Column({ type: 'date', nullable: true })
-    last_credited: Date | null;
-
-    constructor(category: string, MandC_id: number, leave_type_id: number, frequency: enumFrequency, region: string, country: string, location: string, is_carryforward: boolean, carryforward_limit: number, from_date: Date, to_date: Date, reason: string, emergency_balance_days?: number|null, last_credited?: Date|null) {
-        super();
-        this.category = category;
-        this.MandC_id = MandC_id;
-        this.leave_type_id = leave_type_id;
-        this.frequency = frequency;
-        this.region = region;
-        this.country = country;
-        this.location = location;
-        this.is_carryforward = is_carryforward;
-        this.carryforward_limit = carryforward_limit;
-        this.from_date = from_date;
-        this.to_date = to_date;
-        this.reason = reason;
-        this.emergency_balance_days = emergency_balance_days ?? null;
-        this.last_credited = last_credited ?? null;
-    }
+import { Column, Entity } from "typeorm";
+import { BaseModel } from './BaseModel';
+
+export enum enumFrequency {
+    Monthly = 'Monthly',
+    Yearly = 'Yearly',
+}
+
+//This model is used to store the Financial Grade declaration on the Admin Side
+@Entity({ name: 'leave_configuration' })
+export class LeaveConfiguration extends BaseModel {
+
+    @Column({ type: 'varchar', nullable: true })
+    category: string;
+
+    @Column({ type: 'int', nullable: true })
+    MandC_id: number;
+
+    @Column({ type: 'int', nullable: true })
+    leave_type_id: number;
+
+    @Column({ type: 'varchar', nullable: true })
+    frequency: enumFrequency;
+
+    @Column({ type: 'varchar', nullable: true })
+    region: string;
+
+    @Column({ type: 'varchar', nullable: true })
+    country: string;
+
+    @Column({ type: 'varchar', nullable: true })
+    location: string;
+
+    @Column({ nullable: true, default: false })
+    is_carryforward: boolean;
+
+    @Column({ type: 'int', nullable: true, default: 0 })
+    carryforward_limit: number;
+
+    @Column({ type: 'date', nullable: true })
+    from_date: Date;
+
+    @Column({ type: 'date', nullable: true })
+    to_date: Date;
+
+    @Column({ type: 'varchar', nullable: true })
+    reason: string;
+
+    @Column({ type: 'int', nullable: true })
+    emergency_balance_days: number | null;
+
+    @Column({ type: 'date', nullable: true })
+    last_credited: Date | null;
+
+    constructor(category: string, MandC_id: number, leave_type_id: number, frequency: enumFrequency, region: string, country: string, location: string, is_carryforward: boolean, carryforward_limit: number, from_date: Date, to_date: Date, reason: string, emergency_balance_days?: number|null, last_credited?: Date|null) {
+        super();
+        this.category = category;
+        this.MandC_id = MandC_id;
+        this.leave_type_id = leave_type_id;
+        this.frequency = frequency;
+        this.region = region;
+        this.country = country;
+        this.location = location;
+        this.is_carryforward = is_carryforward;
+        this.carryforward_limit = carryforward_limit;
+        this.from_date = from_date;
+        this.to_date = to_date;
+        this.reason = reason;
+        this.emergency_balance_days = emergency_balance_days ?? null;
+        this.last_credited = last_credited ?? null;
+    }
 }

package/src/models/MissionTravelApprovalModel.ts

@@ -1,100 +1,100 @@
-import { Column, Entity } from "typeorm";
-import { BaseModel } from './BaseModel';
-
-export enum MissionTravelApprovalStatus {
-  PENDING = "Pending",
-  APPROVED = "Approved",
-  REJECTED = "Rejected",
-  RFC = "RFC", // Request for Change
-  IN_PROGRESS = "In Progress"
-}
-
-@Entity({ name: 'mission_travel_approvals' })
-export class MissionTravelApprovalDetails extends BaseModel {
-  @Column({ type: 'integer', nullable: false })
-  request_id: number;
-
-  @Column({ type: 'integer', nullable: true })
-  service_id: number | null;
-
-  @Column({ type: 'integer', nullable: true })
-  sub_service_id: number | null;
-
-  @Column({ type: 'integer', nullable: false })
-  level: number;
-
-  @Column({ type: 'integer', nullable: true })
-  approver_role_id: number;
-
-  @Column({ type: 'integer', nullable: true })
-  department_id: number | null;
-
-  @Column({ type: 'integer', nullable: true })
-  section_id: number | null;
-
-  @Column({ type: 'integer', nullable: true })
-  approver_user_id: number | null;
-
-  @Column({ type: 'integer', nullable: true })
-  delegate_user_id: number | null;
-
-  @Column({ type: 'integer', nullable: true })
-  approved_by: number | null;
-
-  @Column({ type: 'varchar', length: 500, nullable: true, default: '' })
-  comment: string;
-
-  @Column({ type: 'enum', enum: MissionTravelApprovalStatus, default: MissionTravelApprovalStatus.PENDING, nullable: false })
-  approval_status: MissionTravelApprovalStatus;
-
-  @Column({ type: 'boolean', default: true, nullable: false })
-  is_allowed: boolean;
-
-  @Column({ type: 'boolean', default: false, nullable: false })
-  is_reassign: boolean;
-
-  @Column({ type: 'boolean', default: true, nullable: false })
-  is_approval: boolean;
-
-  @Column({ type: 'boolean', default: false, nullable: false })
-  is_review: boolean;
-
-  constructor(
-    request_id: number,
-    service_id: number | null,
-    sub_service_id: number | null,
-    level: number,
-    approver_role_id: number,
-    department_id: number | null,
-    section_id: number | null,
-    approver_user_id: number | null,
-    delegate_user_id: number | null,
-    approved_by: number | null,
-    comment: string,
-    approval_status: MissionTravelApprovalStatus,
-    is_allowed: boolean,
-    is_reassign: boolean,
-    is_approval: boolean,
-    is_review?: boolean
-  ) {
-    super();
-    this.request_id = request_id;
-    this.service_id = service_id;
-    this.sub_service_id = sub_service_id;
-    this.level = level;
-    this.approver_role_id = approver_role_id;
-    this.department_id = department_id;
-    this.section_id = section_id;
-    this.approver_user_id = approver_user_id;
-    this.delegate_user_id = delegate_user_id;
-    this.approved_by = approved_by;
-    this.comment = comment;
-    this.approval_status = approval_status;
-    this.is_allowed = is_allowed;
-    this.is_reassign = is_reassign;
-    this.is_approval = is_approval;
-    this.is_review = is_review ?? false;
-  }
-}
-
-
+import { Column, Entity } from "typeorm";
+import { BaseModel } from './BaseModel';
+
+export enum MissionTravelApprovalStatus {
+  PENDING = "Pending",
+  APPROVED = "Approved",
+  REJECTED = "Rejected",
+  RFC = "RFC", // Request for Change
+  IN_PROGRESS = "In Progress"
+}
+
+@Entity({ name: 'mission_travel_approvals' })
+export class MissionTravelApprovalDetails extends BaseModel {
+  @Column({ type: 'integer', nullable: false })
+  request_id: number;
+
+  @Column({ type: 'integer', nullable: true })
+  service_id: number | null;
+
+  @Column({ type: 'integer', nullable: true })
+  sub_service_id: number | null;
+
+  @Column({ type: 'integer', nullable: false })
+  level: number;
+
+  @Column({ type: 'integer', nullable: true })
+  approver_role_id: number;
+
+  @Column({ type: 'integer', nullable: true })
+  department_id: number | null;
+
+  @Column({ type: 'integer', nullable: true })
+  section_id: number | null;
+
+  @Column({ type: 'integer', nullable: true })
+  approver_user_id: number | null;
+
+  @Column({ type: 'integer', nullable: true })
+  delegate_user_id: number | null;
+
+  @Column({ type: 'integer', nullable: true })
+  approved_by: number | null;
+
+  @Column({ type: 'varchar', length: 500, nullable: true, default: '' })
+  comment: string;
+
+  @Column({ type: 'enum', enum: MissionTravelApprovalStatus, default: MissionTravelApprovalStatus.PENDING, nullable: false })
+  approval_status: MissionTravelApprovalStatus;
+
+  @Column({ type: 'boolean', default: true, nullable: false })
+  is_allowed: boolean;
+
+  @Column({ type: 'boolean', default: false, nullable: false })
+  is_reassign: boolean;
+
+  @Column({ type: 'boolean', default: true, nullable: false })
+  is_approval: boolean;
+
+  @Column({ type: 'boolean', default: false, nullable: false })
+  is_review: boolean;
+
+  constructor(
+    request_id: number,
+    service_id: number | null,
+    sub_service_id: number | null,
+    level: number,
+    approver_role_id: number,
+    department_id: number | null,
+    section_id: number | null,
+    approver_user_id: number | null,
+    delegate_user_id: number | null,
+    approved_by: number | null,
+    comment: string,
+    approval_status: MissionTravelApprovalStatus,
+    is_allowed: boolean,
+    is_reassign: boolean,
+    is_approval: boolean,
+    is_review?: boolean
+  ) {
+    super();
+    this.request_id = request_id;
+    this.service_id = service_id;
+    this.sub_service_id = sub_service_id;
+    this.level = level;
+    this.approver_role_id = approver_role_id;
+    this.department_id = department_id;
+    this.section_id = section_id;
+    this.approver_user_id = approver_user_id;
+    this.delegate_user_id = delegate_user_id;
+    this.approved_by = approved_by;
+    this.comment = comment;
+    this.approval_status = approval_status;
+    this.is_allowed = is_allowed;
+    this.is_reassign = is_reassign;
+    this.is_approval = is_approval;
+    this.is_review = is_review ?? false;
+  }
+}
+
+