@platform-modules/foreign-ministry 1.3.8 → 1.3.10

package/src/models/DiplomaticRequestsModel.ts

@@ -1,157 +1,157 @@
-import { Column, Entity, OneToOne, OneToMany, ManyToOne, JoinColumn } from "typeorm";
-import { BaseModel } from './BaseModel';
-
-// Import types only (not for runtime)
-import type { DiplomaticApprovals } from './DiplomaticApprovalsModel';
-import type { DiplomaticWorkFlow } from './DiplomaticWorkFlowModel';
-import type { DiplomaticAttachments } from './DiplomaticAttachmentsModel';
-import type { DiplomaticChats } from './DiplomaticChatsModel';
-import type { DiplomaticClubCardMembers } from './DiplomaticClubCardMembersModel';
-
-export enum DiplomaticRequestStatus {
-  DRAFT = "Draft",
-  SUBMITTED = "Submitted",
-  PENDING = "Pending",
-  IN_PROGRESS = "In Progress",
-  APPROVED = "Approved",
-  REJECTED = "Rejected",
-  COMPLETED = "Completed",
-  CANCELLED = "Cancelled"
-}
-
-@Entity({ name: 'diplomatic_requests' })
-export class DiplomaticRequests extends BaseModel {
-  @Column({ type: 'int' })
-  user_id: number;
-
-  @Column({ type: 'varchar', length: 100 })
-  employee_id: string;
-
-  @Column({ type: 'varchar', length: 255 })
-  employee_name: string;
-
-  @Column({ type: 'varchar', length: 100, nullable: true })
-  grade: string | null;
-
-  @Column({ type: 'int', nullable: true })
-  designation_id: number | null;
-
-  @Column({ type: 'int', nullable: true })
-  department_id: number | null;
-
-  @Column({ type: 'varchar', length: 255 })
-  email_address: string;
-
-  @Column({ type: 'varchar', length: 20 })
-  contact_number: string;
-
-  @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
-  request_date: Date;
-
-  @Column({ type: 'enum', enum: DiplomaticRequestStatus, default: DiplomaticRequestStatus.PENDING })
-  request_status: DiplomaticRequestStatus;
-
-  @Column({ type: 'timestamp', nullable: true })
-  request_close_date: Date | null;
-
-  @Column({ type: 'date', nullable: true })
-  end_date: Date | null;
-
-  @Column({ type: 'text', nullable: true })
-  remarks: string | null;
-
-  @Column({ type: 'int', nullable: true })
-  current_approval_level: number | null;
-
-  @Column({ type: 'int', nullable: true })
-  current_approver_id: number | null;
-
-  @Column({ type: 'int', nullable: true })
-  service_id: number | null;
-
-  @Column({ type: 'int', nullable: true })
-  sub_service_id: number | null;
-
-  @Column({ type: 'varchar', length: 255, nullable: true })
-  member_name: string | null;
-
-  @Column({ type: 'varchar', length: 100, nullable: true })
-  membership_type: string | null;
-
-  @Column({ type: 'int', nullable: true })
-  diplomatic_title_id: number | null;
-
-  @Column({ type: 'varchar', length: 255, nullable: true })
-  location: string | null;
-
-  @Column({ type: 'varchar', length: 100, nullable: true })
-  request_type: string | null;
-
-  @Column({ type: 'date', nullable: true })
-  expiry_date: Date | null;
-
-  @Column({ type: 'varchar', length: 500, nullable: true })
-  photo_url: string | null;
-
-  @Column({ type: 'varchar', length: 100, nullable: true })
-  membership_id: string | null;
-
-  @Column({ type: 'varchar', length: 255, nullable: true })
-  organization: string | null;
-
-  @Column({ type: 'decimal', precision: 10, scale: 2, nullable: true })
-  subscription_amount: number | null;
-
-  @Column({ type: 'int', nullable: true })
-  section_id: number | null;
-
-  @Column({ type: 'int', nullable: true })
-  reporting_manager: number | null;
-
-  @Column({ type: 'varchar', length: 255, nullable: true })
-  workflow_execution_id: string | null;
-
-  @Column({ type: 'json', nullable: true })
-  titles: any[] | null;
-
-  @OneToMany('DiplomaticClubCardMembers', 'diplomaticRequest', { nullable: true })
-  diplomaticClubCardMembers?: DiplomaticClubCardMembers[];
-
-  @OneToMany('DiplomaticApprovals', 'diplomaticRequest')
-  approvals?: DiplomaticApprovals[];
-
-  @OneToMany('DiplomaticWorkFlow', 'diplomaticRequest')
-  workflows?: DiplomaticWorkFlow[];
-
-  @OneToMany('DiplomaticAttachments', 'diplomaticRequest')
-  attachments?: DiplomaticAttachments[];
-
-  @OneToMany('DiplomaticChats', 'diplomaticRequest')
-  chats?: DiplomaticChats[];
-
-  constructor(
-    user_id: number,
-    employee_id: string,
-    employee_name: string,
-    email_address: string,
-    contact_number: string,
-    service_id: number | null,
-    sub_service_id: number | null,
-    section_id: number | null,
-    reporting_manager: number | null
-  ) {
-    super();
-    this.user_id = user_id;
-    this.employee_id = employee_id;
-    this.employee_name = employee_name;
-    this.email_address = email_address;
-    this.contact_number = contact_number;
-    this.request_date = new Date();
-    this.request_status = DiplomaticRequestStatus.PENDING;
-    this.service_id = service_id;
-    this.sub_service_id = sub_service_id;
-    this.section_id = section_id;
-    this.reporting_manager = reporting_manager;
-  }
-}
-
+import { Column, Entity, OneToOne, OneToMany, ManyToOne, JoinColumn } from "typeorm";
+import { BaseModel } from './BaseModel';
+
+// Import types only (not for runtime)
+import type { DiplomaticApprovals } from './DiplomaticApprovalsModel';
+import type { DiplomaticWorkFlow } from './DiplomaticWorkFlowModel';
+import type { DiplomaticAttachments } from './DiplomaticAttachmentsModel';
+import type { DiplomaticChats } from './DiplomaticChatsModel';
+import type { DiplomaticClubCardMembers } from './DiplomaticClubCardMembersModel';
+
+export enum DiplomaticRequestStatus {
+  DRAFT = "Draft",
+  SUBMITTED = "Submitted",
+  PENDING = "Pending",
+  IN_PROGRESS = "In Progress",
+  APPROVED = "Approved",
+  REJECTED = "Rejected",
+  COMPLETED = "Completed",
+  CANCELLED = "Cancelled"
+}
+
+@Entity({ name: 'diplomatic_requests' })
+export class DiplomaticRequests extends BaseModel {
+  @Column({ type: 'int' })
+  user_id: number;
+
+  @Column({ type: 'varchar', length: 100 })
+  employee_id: string;
+
+  @Column({ type: 'varchar', length: 255 })
+  employee_name: string;
+
+  @Column({ type: 'varchar', length: 100, nullable: true })
+  grade: string | null;
+
+  @Column({ type: 'int', nullable: true })
+  designation_id: number | null;
+
+  @Column({ type: 'int', nullable: true })
+  department_id: number | null;
+
+  @Column({ type: 'varchar', length: 255 })
+  email_address: string;
+
+  @Column({ type: 'varchar', length: 20 })
+  contact_number: string;
+
+  @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
+  request_date: Date;
+
+  @Column({ type: 'enum', enum: DiplomaticRequestStatus, default: DiplomaticRequestStatus.PENDING })
+  request_status: DiplomaticRequestStatus;
+
+  @Column({ type: 'timestamp', nullable: true })
+  request_close_date: Date | null;
+
+  @Column({ type: 'date', nullable: true })
+  end_date: Date | null;
+
+  @Column({ type: 'text', nullable: true })
+  remarks: string | null;
+
+  @Column({ type: 'int', nullable: true })
+  current_approval_level: number | null;
+
+  @Column({ type: 'int', nullable: true })
+  current_approver_id: number | null;
+
+  @Column({ type: 'int', nullable: true })
+  service_id: number | null;
+
+  @Column({ type: 'int', nullable: true })
+  sub_service_id: number | null;
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  member_name: string | null;
+
+  @Column({ type: 'varchar', length: 100, nullable: true })
+  membership_type: string | null;
+
+  @Column({ type: 'int', nullable: true })
+  diplomatic_title_id: number | null;
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  location: string | null;
+
+  @Column({ type: 'varchar', length: 100, nullable: true })
+  request_type: string | null;
+
+  @Column({ type: 'date', nullable: true })
+  expiry_date: Date | null;
+
+  @Column({ type: 'varchar', length: 500, nullable: true })
+  photo_url: string | null;
+
+  @Column({ type: 'varchar', length: 100, nullable: true })
+  membership_id: string | null;
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  organization: string | null;
+
+  @Column({ type: 'decimal', precision: 10, scale: 2, nullable: true })
+  subscription_amount: number | null;
+
+  @Column({ type: 'int', nullable: true })
+  section_id: number | null;
+
+  @Column({ type: 'int', nullable: true })
+  reporting_manager: number | null;
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  workflow_execution_id: string | null;
+
+  @Column({ type: 'json', nullable: true })
+  titles: any[] | null;
+
+  @OneToMany('DiplomaticClubCardMembers', 'diplomaticRequest', { nullable: true })
+  diplomaticClubCardMembers?: DiplomaticClubCardMembers[];
+
+  @OneToMany('DiplomaticApprovals', 'diplomaticRequest')
+  approvals?: DiplomaticApprovals[];
+
+  @OneToMany('DiplomaticWorkFlow', 'diplomaticRequest')
+  workflows?: DiplomaticWorkFlow[];
+
+  @OneToMany('DiplomaticAttachments', 'diplomaticRequest')
+  attachments?: DiplomaticAttachments[];
+
+  @OneToMany('DiplomaticChats', 'diplomaticRequest')
+  chats?: DiplomaticChats[];
+
+  constructor(
+    user_id: number,
+    employee_id: string,
+    employee_name: string,
+    email_address: string,
+    contact_number: string,
+    service_id: number | null,
+    sub_service_id: number | null,
+    section_id: number | null,
+    reporting_manager: number | null
+  ) {
+    super();
+    this.user_id = user_id;
+    this.employee_id = employee_id;
+    this.employee_name = employee_name;
+    this.email_address = email_address;
+    this.contact_number = contact_number;
+    this.request_date = new Date();
+    this.request_status = DiplomaticRequestStatus.PENDING;
+    this.service_id = service_id;
+    this.sub_service_id = sub_service_id;
+    this.section_id = section_id;
+    this.reporting_manager = reporting_manager;
+  }
+}
+

package/src/models/GatePassApprovalsModel.ts

@@ -0,0 +1,98 @@
+import { Column, Entity } from "typeorm";
+import { BaseModel } from './BaseModel';
+
+/**
+ * Gate Pass Approval Status Enum
+ */
+export enum GatePassApprovalStatus {
+  PENDING = "Pending",
+  IN_PROGRESS = "In Progress",
+  APPROVED = "Approved",
+  REJECTED = "Rejected",
+  CANCELLED = "Cancelled"
+}
+
+/**
+ * Gate Pass Approval Details Table
+ * Stores approval information for each level of the workflow
+ * Workflow: Employee → Department Admin Office → Security Department
+ */
+@Entity({ name: 'gate_pass_approvals' })
+export class GatePassApprovalDetails extends BaseModel {
+  
+  @Column({ type: 'int', nullable: false })
+  gate_pass_request_id: number; // Foreign key to gate_pass_requests
+
+  @Column({ type: 'int', nullable: false })
+  level: number; // Approval level (1: Department Admin Office, 2: Security Department)
+
+  @Column({ type: 'int', nullable: true })
+  approver_user_id: number | null;
+
+  @Column({ type: 'int', nullable: true })
+  approver_role_id: number | null;
+
+  @Column({ type: 'integer', nullable: true })
+  delegate_user_id: number | null; // If someone is delegating approval
+
+  @Column({ type: 'integer', nullable: true })
+  approved_by: number | null; // Actual user who approved (in case of delegation)
+
+  @Column({ type: 'int', nullable: true })
+  department_id: number | null;
+
+  @Column({ type: 'int', nullable: true })
+  section_id: number | null;
+
+  @Column({ type: 'text', nullable: true })
+  comment: string | null; // Approval/rejection comment
+
+  @Column({ type: 'enum', enum: GatePassApprovalStatus, default: GatePassApprovalStatus.PENDING, nullable: false })
+  approval_status: GatePassApprovalStatus;
+
+  @Column({ type: 'boolean', default: true, nullable: false })
+  is_allowed: boolean; // Whether this approval step is allowed
+
+  @Column({ type: 'varchar', length: 50, nullable: true })
+  access_type: string | null; // Normal - to track access type
+
+  @Column({ type: 'integer', nullable: true })
+  service_id: number | null;
+
+  @Column({ type: 'integer', nullable: true })
+  sub_service_id: number | null;
+
+  constructor(
+    gate_pass_request_id: number,
+    level: number,
+    approver_user_id: number | null,
+    approver_role_id: number | null,
+    delegate_user_id: number | null,
+    approved_by: number | null,
+    department_id: number | null,
+    section_id: number | null,
+    comment: string | null,
+    approval_status: GatePassApprovalStatus,
+    is_allowed: boolean,
+    access_type: string | null,
+    service_id: number | null,
+    sub_service_id: number | null
+  ) {
+    super();
+    this.gate_pass_request_id = gate_pass_request_id;
+    this.level = level;
+    this.approver_user_id = approver_user_id;
+    this.approver_role_id = approver_role_id;
+    this.delegate_user_id = delegate_user_id;
+    this.approved_by = approved_by;
+    this.department_id = department_id;
+    this.section_id = section_id;
+    this.comment = comment;
+    this.approval_status = approval_status;
+    this.is_allowed = is_allowed;
+    this.access_type = access_type;
+    this.service_id = service_id;
+    this.sub_service_id = sub_service_id;
+  }
+}
+

package/src/models/GatePassAttachmentsModel.ts

@@ -0,0 +1,38 @@
+import { Column, Entity } from "typeorm";
+import { BaseModel } from './BaseModel';
+
+/**
+ * Gate Pass Request Attachment Table
+ * Stores file attachments for gate pass requests
+ */
+@Entity({ name: 'gate_pass_attachments' })
+export class GatePassRequestAttachment 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: 'varchar', length: 500, nullable: false })
+  file_url: string;
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  file_name: string;
+
+  @Column({ type: 'varchar', length: 100, nullable: true })
+  file_type: string;
+
+  @Column({ type: 'bigint', nullable: true })
+  file_size: number | null;
+
+  @Column({ type: 'integer', nullable: true })
+  chat_id: number | null;
+
+  @Column({ type: 'text', nullable: true })
+  description: string | null; // Optional description for the attachment
+}
+

package/src/models/GatePassChatsModel.ts

@@ -0,0 +1,72 @@
+import { Column, Entity } from "typeorm";
+import { BaseModel } from './BaseModel';
+
+/**
+ * Gate Pass Message Type Enum
+ */
+export enum GatePassMessageType {
+  TEXT = "text",
+  IMAGE = "image",
+  VIDEO = "video",
+  FILE = "file",
+  LINK = "link"
+}
+
+/**
+ * Gate Pass Request Chat Table
+ * Stores chat messages for gate pass requests
+ */
+@Entity({ name: 'gate_pass_chats' })
+export class GatePassRequestChat 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 })
+  user_id: number;
+
+  @Column({ type: 'integer', nullable: true })
+  role_id: number;
+
+  @Column({ type: 'text', nullable: false })
+  message: string;
+
+  @Column({
+    type: 'enum',
+    enum: GatePassMessageType,
+    default: GatePassMessageType.TEXT,
+    nullable: false
+  })
+  messageType: GatePassMessageType;
+
+  @Column({ type: 'text', nullable: true })
+  status: string;
+
+  constructor(
+    request_id: number,
+    user_id: number,
+    role_id: number,
+    message: string,
+    service_id?: number,
+    sub_service_id?: number,
+    messageType?: GatePassMessageType,
+    status?: string
+  ) {
+    super();
+    this.request_id = request_id;
+    this.service_id = service_id || null;
+    this.sub_service_id = sub_service_id || null;
+    this.user_id = user_id;
+    this.role_id = role_id;
+    this.message = message;
+    this.messageType = messageType || GatePassMessageType.TEXT;
+    this.status = status || 'Pending';
+  }
+}
+

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;
+  }
+}
+