@platform-modules/foreign-ministry 1.3.275 → 1.3.277

package/src/models/AnnualTravelTicketEmployeeAllocationFamilyModel.ts

@@ -0,0 +1,33 @@
+import { Column, Entity } from 'typeorm';
+import { BaseModel } from './BaseModel';
+
+/** One JSON row per child age band / pool (carry, allocated total, used). */
+export interface AnnualTravelTicketChildTicketPool {
+  age_category: string;
+  relation?: string;
+  carry_forward: number;
+  total_allocated: number;
+  used: number;
+}
+
+/**
+ * Spouse: real columns. Children: JSON array column `children_pools` (age_category buckets only).
+ * Linked to annual_travel_ticket_employee_allocations by allocation_id only (no ORM relation).
+ */
+@Entity({ name: 'annual_travel_ticket_employee_allocation_family' })
+export class AnnualTravelTicketEmployeeAllocationFamily extends BaseModel {
+  @Column({ type: 'int', nullable: false, unique: true })
+  allocation_id: number;
+
+  @Column({ type: 'int', default: 0 })
+  spouse_carry_forward: number;
+
+  @Column({ type: 'int', default: 0 })
+  spouse_total_allocated: number;
+
+  @Column({ type: 'int', default: 0 })
+  spouse_used: number;
+
+  @Column({ type: 'jsonb', nullable: false, default: () => "'[]'::jsonb" })
+  children_pools: AnnualTravelTicketChildTicketPool[];
+}

package/src/models/AnnualTravelTicketEmployeeAllocationModel.ts

@@ -0,0 +1,32 @@
+import { Column, Entity, Index } from 'typeorm';
+import { BaseModel } from './BaseModel';
+
+/**
+ * Per employee + year: employee self pool (columns) + history_log.
+ * Spouse / children live on annual_travel_ticket_employee_allocation_family (allocation_id FK only).
+ */
+@Entity({ name: 'annual_travel_ticket_employee_allocations' })
+@Index('idx_att_alloc_user_year', ['employee_user_id', 'ticket_year'])
+export class AnnualTravelTicketEmployeeAllocation extends BaseModel {
+  @Column({ type: 'int', nullable: false })
+  employee_user_id: number;
+
+  @Column({ type: 'int', nullable: false })
+  ticket_year: number;
+
+  @Column({ type: 'int', default: 0 })
+  employee_carry_forward: number;
+
+  @Column({ type: 'int', default: 0 })
+  employee_total_allocated: number;
+
+  @Column({ type: 'int', default: 0 })
+  employee_used: number;
+
+  /** Append-only change history: { at, by, action, snapshot } */
+  @Column({ type: 'jsonb', nullable: false, default: () => "'[]'::jsonb" })
+  history_log: Array<{ at: string; by: string; action: string; snapshot?: Record<string, unknown> }>;
+
+  @Column({ type: 'varchar', length: 2000, nullable: true })
+  notes: string | null;
+}

package/src/models/AnnualTravelTicketPriceConfigurationItemModel.ts

@@ -1,36 +1,36 @@
-import { Column, Entity, JoinColumn, ManyToOne, Unique } from 'typeorm';
-import { BaseModel } from './BaseModel';
-import { AnnualTravelTicketPriceConfiguration } from './AnnualTravelTicketPriceConfigurationModel';
-
-/**
- * Individual price slab within an annual travel ticket pricing configuration.
- * age_from is inclusive and age_to is exclusive to allow adjacent ranges.
- */
-@Entity({ name: 'annual_travel_ticket_price_configuration_items' })
-@Unique(['configuration_id', 'ticket_class', 'age_from', 'age_to'])
-export class AnnualTravelTicketPriceConfigurationItem extends BaseModel {
-  @Column({ type: 'int', nullable: false })
-  configuration_id: number;
-
-  @ManyToOne(() => AnnualTravelTicketPriceConfiguration, (configuration) => configuration.price_slabs, { onDelete: 'CASCADE' })
-  @JoinColumn({ name: 'configuration_id' })
-  configuration: AnnualTravelTicketPriceConfiguration;
-
-  @Column({ type: 'varchar', length: 100, nullable: true })
-  ticket_class: string | null;
-
-  @Column({ type: 'int', nullable: false })
-  age_from: number;
-
-  @Column({ type: 'int', nullable: false })
-  age_to: number;
-
-  @Column({ type: 'decimal', precision: 12, scale: 2, nullable: false })
-  price: number | string;
-
-  @Column({ type: 'varchar', length: 10, nullable: true, default: 'OMR' })
-  currency_code: string | null;
-
-  @Column({ type: 'text', nullable: true })
-  notes: string | null;
-}
+import { Column, Entity, JoinColumn, ManyToOne, Unique } from 'typeorm';
+import { BaseModel } from './BaseModel';
+import { AnnualTravelTicketPriceConfiguration } from './AnnualTravelTicketPriceConfigurationModel';
+
+/**
+ * Individual price slab within an annual travel ticket pricing configuration.
+ * age_from is inclusive and age_to is exclusive to allow adjacent ranges.
+ */
+@Entity({ name: 'annual_travel_ticket_price_configuration_items' })
+@Unique(['configuration_id', 'ticket_class', 'age_from', 'age_to'])
+export class AnnualTravelTicketPriceConfigurationItem extends BaseModel {
+  @Column({ type: 'int', nullable: false })
+  configuration_id: number;
+
+  @ManyToOne(() => AnnualTravelTicketPriceConfiguration, (configuration) => configuration.price_slabs, { onDelete: 'CASCADE' })
+  @JoinColumn({ name: 'configuration_id' })
+  configuration: AnnualTravelTicketPriceConfiguration;
+
+  @Column({ type: 'varchar', length: 100, nullable: true })
+  ticket_class: string | null;
+
+  @Column({ type: 'int', nullable: false })
+  age_from: number;
+
+  @Column({ type: 'int', nullable: false })
+  age_to: number;
+
+  @Column({ type: 'decimal', precision: 12, scale: 2, nullable: false })
+  price: number | string;
+
+  @Column({ type: 'varchar', length: 10, nullable: true, default: 'OMR' })
+  currency_code: string | null;
+
+  @Column({ type: 'text', nullable: true })
+  notes: string | null;
+}

package/src/models/AnnualTravelTicketPriceConfigurationModel.ts

@@ -1,35 +1,35 @@
-import { Column, Entity, OneToMany, Unique } from 'typeorm';
-import { BaseModel } from './BaseModel';
-import { AnnualTravelTicketPriceConfigurationItem } from './AnnualTravelTicketPriceConfigurationItemModel';
-
-/**
- * Admin configuration for annual travel ticket pricing.
- * One record per year (and optional service/sub-service pair), with multiple age slabs.
- */
-@Entity({ name: 'annual_travel_ticket_price_configurations' })
-@Unique(['service_id', 'sub_service_id', 'ticket_year'])
-export class AnnualTravelTicketPriceConfiguration extends BaseModel {
-  @Column({ type: 'int', nullable: true })
-  service_id: number | null;
-
-  @Column({ type: 'int', nullable: true })
-  sub_service_id: number | null;
-
-  @Column({ type: 'int', nullable: false })
-  ticket_year: number;
-
-  @Column({ type: 'varchar', length: 255, nullable: true })
-  configuration_name: string | null;
-
-  @Column({ type: 'varchar', length: 10, nullable: true, default: 'OMR' })
-  currency_code: string | null;
-
-  @Column({ type: 'text', nullable: true })
-  description: string | null;
-
-  @Column({ type: 'boolean', default: true, nullable: false })
-  is_active: boolean;
-
-  @OneToMany(() => AnnualTravelTicketPriceConfigurationItem, (item) => item.configuration)
-  price_slabs?: AnnualTravelTicketPriceConfigurationItem[];
-}
+import { Column, Entity, OneToMany, Unique } from 'typeorm';
+import { BaseModel } from './BaseModel';
+import { AnnualTravelTicketPriceConfigurationItem } from './AnnualTravelTicketPriceConfigurationItemModel';
+
+/**
+ * Admin configuration for annual travel ticket pricing.
+ * One record per year (and optional service/sub-service pair), with multiple age slabs.
+ */
+@Entity({ name: 'annual_travel_ticket_price_configurations' })
+@Unique(['service_id', 'sub_service_id', 'ticket_year'])
+export class AnnualTravelTicketPriceConfiguration extends BaseModel {
+  @Column({ type: 'int', nullable: true })
+  service_id: number | null;
+
+  @Column({ type: 'int', nullable: true })
+  sub_service_id: number | null;
+
+  @Column({ type: 'int', nullable: false })
+  ticket_year: number;
+
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  configuration_name: string | null;
+
+  @Column({ type: 'varchar', length: 10, nullable: true, default: 'OMR' })
+  currency_code: string | null;
+
+  @Column({ type: 'text', nullable: true })
+  description: string | null;
+
+  @Column({ type: 'boolean', default: true, nullable: false })
+  is_active: boolean;
+
+  @OneToMany(() => AnnualTravelTicketPriceConfigurationItem, (item) => item.configuration)
+  price_slabs?: AnnualTravelTicketPriceConfigurationItem[];
+}

package/src/models/AnnualTravelTicketRequestModel.ts

@@ -1,23 +1,23 @@
-import { Column, Entity } from 'typeorm';
-import { BaseModel } from './BaseModel';
-
-export enum AnnualTravelTicketPermanentResidence {
-  SALALAH = 'Salalah',
-  MUSANDAM = 'Musandam',
-}
-
-export interface AnnualTravelTicketFamilyDetail {
-  person_name: string;
-  relation: string;
-  age: number;
-  age_category: string;
-  price: number | string;
-}
-
-/** Aligns with mission bank account request lifecycle for shared workflow UI. */
-export enum AnnualTravelTicketRequestStatus {
-  PENDING = 'Pending',
-  ASSIGNED = 'Assigned',
+import { Column, Entity } from 'typeorm';
+import { BaseModel } from './BaseModel';
+
+export enum AnnualTravelTicketPermanentResidence {
+  SALALAH = 'Salalah',
+  MUSANDAM = 'Musandam',
+}
+
+export interface AnnualTravelTicketFamilyDetail {
+  person_name: string;
+  relation: string;
+  age: number;
+  age_category: string;
+  price: number | string;
+}
+
+/** Aligns with mission bank account request lifecycle for shared workflow UI. */
+export enum AnnualTravelTicketRequestStatus {
+  PENDING = 'Pending',
+  ASSIGNED = 'Assigned',
   IN_PROGRESS = 'In Progress',
   APPROVED = 'Approved',
   REJECTED = 'Rejected',
@@ -47,28 +47,28 @@ export class AnnualTravelTicketRequests extends BaseModel {
   @Column({ type: 'varchar', length: 120, nullable: false })
   civil_id_or_passport_number: string;
 
-  @Column({ type: 'enum', enum: AnnualTravelTicketPermanentResidence, nullable: false })
-  permanent_residence: AnnualTravelTicketPermanentResidence;
-
-  /** Traveler list with person name, relation, age, age category, and price. */
-  @Column({ type: 'jsonb', nullable: true })
-  family_details: AnnualTravelTicketFamilyDetail[] | null;
-
-  @Column({ type: 'varchar', length: 100, nullable: false })
-  bank_account_number: string;
-
-  @Column({ type: 'varchar', length: 255, nullable: false })
-  travel_from: string;
-
-  @Column({ type: 'varchar', length: 255, nullable: false })
-  travel_to: string;
-
-  @Column({ type: 'date', nullable: false })
-  date_of_travel: string;
-
-  @Column({
-    type: 'enum',
-    enum: AnnualTravelTicketRequestStatus,
+  @Column({ type: 'enum', enum: AnnualTravelTicketPermanentResidence, nullable: false })
+  permanent_residence: AnnualTravelTicketPermanentResidence;
+
+  /** Traveler list with person name, relation, age, age category, and price. */
+  @Column({ type: 'jsonb', nullable: true })
+  family_details: AnnualTravelTicketFamilyDetail[] | null;
+
+  @Column({ type: 'varchar', length: 100, nullable: false })
+  bank_account_number: string;
+
+  @Column({ type: 'varchar', length: 255, nullable: false })
+  travel_from: string;
+
+  @Column({ type: 'varchar', length: 255, nullable: false })
+  travel_to: string;
+
+  @Column({ type: 'date', nullable: false })
+  date_of_travel: string;
+
+  @Column({
+    type: 'enum',
+    enum: AnnualTravelTicketRequestStatus,
     default: AnnualTravelTicketRequestStatus.PENDING,
     nullable: false,
   })

package/src/models/DiplomaticAcademyRequestModel.ts

@@ -1,80 +1,80 @@
-import { Column, Entity } from "typeorm";
-import { BaseModel } from './BaseModel';
-
-export enum DiplomaticAcademyStatus {
-  SUBMITTED = "Submitted",
-  PENDING = "Pending",
-  ASSIGNED = "Assigned",
-  IN_PROGRESS = "In Progress",
-  APPROVED = "Approved",
-  REJECTED = "Rejected"
-}
-
-@Entity({ name: 'diplomatic_academy_requests' })
-export class DiplomaticAcademyRequests extends BaseModel {
-
-  // Common columns
-  @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;
-
-  @Column({ type: 'int', nullable: false })
-  user_id: number;
-
-  // Diplomatic Academy specific columns
-  @Column({ type: 'varchar', length: 500, nullable: false })
-  course_name: string;
-
-  @Column({ type: 'jsonb', nullable: true })
-  cost_details: {
-    material_price?: number;
-    transportation?: number;
-    accommodation?: number;
-    allowances?: number;
-    food?: number;
-    present?: number;
-  } | null;
-
-  @Column({ type: 'int', nullable: false })
-  estimated_participants: number;
-
-  @Column({ type: 'date', nullable: false })
-  timeline_date_from: Date;
-
-  @Column({ type: 'date', nullable: false })
-  timeline_date_to: Date;
-
-  @Column({ type: 'time', nullable: true })
-  timeline_time_from: string | null;
-
-  @Column({ type: 'time', nullable: true })
-  timeline_time_to: string | null;
-
-  @Column({ type: 'jsonb', nullable: false })
-  participants_details: Array<{
-    full_name: string;
-    passport: string;
-    age: number;
-    qualifications: string;
-    experience: string;
-    institution: string;
-  }>;
-
-  @Column({ type: 'enum', enum: DiplomaticAcademyStatus, default: DiplomaticAcademyStatus.PENDING, nullable: false })
-  status: DiplomaticAcademyStatus;
-
-  @Column({ type: 'int', nullable: true })
-  course_id: number | null;
-
-  @Column({ type: 'varchar', nullable: true })
-  workflow_execution_id: string | null;
-  
-}
+import { Column, Entity } from "typeorm";
+import { BaseModel } from './BaseModel';
+
+export enum DiplomaticAcademyStatus {
+  SUBMITTED = "Submitted",
+  PENDING = "Pending",
+  ASSIGNED = "Assigned",
+  IN_PROGRESS = "In Progress",
+  APPROVED = "Approved",
+  REJECTED = "Rejected"
+}
+
+@Entity({ name: 'diplomatic_academy_requests' })
+export class DiplomaticAcademyRequests extends BaseModel {
+
+  // Common columns
+  @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;
+
+  @Column({ type: 'int', nullable: false })
+  user_id: number;
+
+  // Diplomatic Academy specific columns
+  @Column({ type: 'varchar', length: 500, nullable: false })
+  course_name: string;
+
+  @Column({ type: 'jsonb', nullable: true })
+  cost_details: {
+    material_price?: number;
+    transportation?: number;
+    accommodation?: number;
+    allowances?: number;
+    food?: number;
+    present?: number;
+  } | null;
+
+  @Column({ type: 'int', nullable: false })
+  estimated_participants: number;
+
+  @Column({ type: 'date', nullable: false })
+  timeline_date_from: Date;
+
+  @Column({ type: 'date', nullable: false })
+  timeline_date_to: Date;
+
+  @Column({ type: 'time', nullable: true })
+  timeline_time_from: string | null;
+
+  @Column({ type: 'time', nullable: true })
+  timeline_time_to: string | null;
+
+  @Column({ type: 'jsonb', nullable: false })
+  participants_details: Array<{
+    full_name: string;
+    passport: string;
+    age: number;
+    qualifications: string;
+    experience: string;
+    institution: string;
+  }>;
+
+  @Column({ type: 'enum', enum: DiplomaticAcademyStatus, default: DiplomaticAcademyStatus.PENDING, nullable: false })
+  status: DiplomaticAcademyStatus;
+
+  @Column({ type: 'int', nullable: true })
+  course_id: number | null;
+
+  @Column({ type: 'varchar', nullable: true })
+  workflow_execution_id: string | null;
+  
+}

package/src/models/DocumentationFileModel.ts

@@ -1,40 +1,40 @@
-import { Column, Entity } from 'typeorm';
-import { BaseModel } from './BaseModel';
-
-@Entity({ name: 'documentation_files' })
-export class DocumentationFile extends BaseModel {
-  @Column({ type: 'int', nullable: true })
-  project_id: number | null;
-
-  @Column({ type: 'int' })
-  folder_id: number;
-
-  @Column({ type: 'text', nullable: true })
-  file_path: string;
-
-  @Column({ type: 'varchar', length: 500, nullable: true })
-  filename: string;
-
-  @Column({ type: 'bigint', nullable: true })
-  filesize: number;
-
-  @Column({ type: 'varchar', length: 100, nullable: true })
-  filetype: string;
-
-  constructor(
-    project_id?: number | null,
-    folder_id?: number,
-    file_path?: string,
-    filename?: string,
-    filesize?: number,
-    filetype?: string
-  ) {
-    super();
-    this.project_id = project_id ?? null;
-    this.folder_id = folder_id ?? 0;
-    this.file_path = file_path ?? '';
-    this.filename = filename ?? '';
-    this.filesize = filesize ?? 0;
-    this.filetype = filetype ?? '';
-  }
-}
+import { Column, Entity } from 'typeorm';
+import { BaseModel } from './BaseModel';
+
+@Entity({ name: 'documentation_files' })
+export class DocumentationFile extends BaseModel {
+  @Column({ type: 'int', nullable: true })
+  project_id: number | null;
+
+  @Column({ type: 'int' })
+  folder_id: number;
+
+  @Column({ type: 'text', nullable: true })
+  file_path: string;
+
+  @Column({ type: 'varchar', length: 500, nullable: true })
+  filename: string;
+
+  @Column({ type: 'bigint', nullable: true })
+  filesize: number;
+
+  @Column({ type: 'varchar', length: 100, nullable: true })
+  filetype: string;
+
+  constructor(
+    project_id?: number | null,
+    folder_id?: number,
+    file_path?: string,
+    filename?: string,
+    filesize?: number,
+    filetype?: string
+  ) {
+    super();
+    this.project_id = project_id ?? null;
+    this.folder_id = folder_id ?? 0;
+    this.file_path = file_path ?? '';
+    this.filename = filename ?? '';
+    this.filesize = filesize ?? 0;
+    this.filetype = filetype ?? '';
+  }
+}

package/src/models/EvaluationEligibilitySettingModel.ts

@@ -1,42 +1,42 @@
-import { Column, Entity, JoinColumn, ManyToOne, OneToMany } from 'typeorm';
-import { BaseModel } from './BaseModel';
-
-/**
- * Department/section/month evaluation window: which employees are excluded or re-included
- * for that cycle (e.g. excluded in January, eligible again in May via a different month row).
- */
-@Entity({ name: 'evaluation_eligibility_settings' })
-export class EvaluationEligibilitySetting extends BaseModel {
-  @Column({ type: 'int' })
-  department_id: number;
-
-  @Column({ type: 'int' })
-  section_id: number;
-
-  /** Calendar month 1–12 */
-  @Column({ type: 'int' })
-  month: number;
-
-  @Column({ type: 'date' })
-  evaluation_end_date: Date;
-
-  @Column({ type: 'boolean', default: true })
-  is_active: boolean;
-
-  @OneToMany(() => EvaluationEligibilitySettingEmployee, (e) => e.evaluation_eligibility_setting)
-  employees?: EvaluationEligibilitySettingEmployee[];
-}
-
-@Entity({ name: 'evaluation_eligibility_setting_employees' })
-export class EvaluationEligibilitySettingEmployee extends BaseModel {
-  @ManyToOne(() => EvaluationEligibilitySetting, (s) => s.employees, { onDelete: 'CASCADE' })
-  @JoinColumn({ name: 'setting_id' })
-  evaluation_eligibility_setting: EvaluationEligibilitySetting;
-
-  @Column({ type: 'int' })
-  employee_id: number;
-
-  /** When true, employee is excluded from evaluation for this setting’s month/department/section. */
-  @Column({ type: 'boolean', default: true })
-  is_excluded_from_evaluation: boolean;
-}
+import { Column, Entity, JoinColumn, ManyToOne, OneToMany } from 'typeorm';
+import { BaseModel } from './BaseModel';
+
+/**
+ * Department/section/month evaluation window: which employees are excluded or re-included
+ * for that cycle (e.g. excluded in January, eligible again in May via a different month row).
+ */
+@Entity({ name: 'evaluation_eligibility_settings' })
+export class EvaluationEligibilitySetting extends BaseModel {
+  @Column({ type: 'int' })
+  department_id: number;
+
+  @Column({ type: 'int' })
+  section_id: number;
+
+  /** Calendar month 1–12 */
+  @Column({ type: 'int' })
+  month: number;
+
+  @Column({ type: 'date' })
+  evaluation_end_date: Date;
+
+  @Column({ type: 'boolean', default: true })
+  is_active: boolean;
+
+  @OneToMany(() => EvaluationEligibilitySettingEmployee, (e) => e.evaluation_eligibility_setting)
+  employees?: EvaluationEligibilitySettingEmployee[];
+}
+
+@Entity({ name: 'evaluation_eligibility_setting_employees' })
+export class EvaluationEligibilitySettingEmployee extends BaseModel {
+  @ManyToOne(() => EvaluationEligibilitySetting, (s) => s.employees, { onDelete: 'CASCADE' })
+  @JoinColumn({ name: 'setting_id' })
+  evaluation_eligibility_setting: EvaluationEligibilitySetting;
+
+  @Column({ type: 'int' })
+  employee_id: number;
+
+  /** When true, employee is excluded from evaluation for this setting’s month/department/section. */
+  @Column({ type: 'boolean', default: true })
+  is_excluded_from_evaluation: boolean;
+}