@adaptware/eagles-db 0.4.46 → 0.5.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptware/eagles-db",
-  "version": "0.4.46",
+  "version": "0.5.2",
   "description": "A Prisma client package for Treadspace database operations",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/prisma/schema/budget.prisma

@@ -34,11 +34,15 @@ model Budget {
   jd_creation_type   JDCreationType
   job_description_id String         @unique
   job_description    JobDescription @relation(fields: [job_description_id], references: [id], onDelete: Cascade, onUpdate: Cascade)
+  /// Optional link to annual plan line (legacy Budget API; primary commit path is JobDescription).
+  hiring_plan_line_id String?
+  hiring_plan_line    HiringPlanLine? @relation(fields: [hiring_plan_line_id], references: [id], onDelete: SetNull, onUpdate: Cascade)
   created_at         DateTime       @default(now())
   updated_at         DateTime       @updatedAt
   created_by         String
   updated_by         String
   is_active          Boolean        @default(true)
 
+  @@index([hiring_plan_line_id])
   @@schema("public")
 }

package/prisma/schema/candidateProfile.prisma

@@ -15,14 +15,15 @@ model CandidateProfile {
 
   resume Resume? @relation(fields: [resume_id], references: [id], onDelete: SetNull, onUpdate: Cascade)
 
-  work_experience   Json?
-  education         Json?
-  notice_period     String?
-  gender            String?
-  ethnicity         String?
-  veteran_status    String?
-  disability_status String?
-  is_active         Boolean @default(true)
+  work_experience    Json?
+  education          Json?
+  notice_period      String?
+  gender             String?
+  ethnicity          String?
+  veteran_status     String?
+  disability_status  String?
+  is_active          Boolean             @default(true)
+  planned_candidates PlannedCandidate[]
 
   @@schema("public")
 }

package/prisma/schema/department.prisma

@@ -0,0 +1,89 @@
+/// Section-level status for a department's slice of the hiring plan.
+/// DRAFT   — department head is editing
+/// SUBMITTED — head submitted; awaiting CHRO
+/// APPROVED  — CHRO locked; line writes rejected until reopened to DRAFT
+enum HiringPlanSectionStatus {
+  DRAFT
+  SUBMITTED
+  APPROVED
+
+  @@schema("public")
+}
+
+/// First-class org unit that owns a slice of the annual hiring plan.
+/// Replaces the free-text `business_unit` string on HiringPlanLine / Employee.
+/// Headship lives on DepartmentMember.is_head (at most one per dept, enforced in service).
+model Department {
+  id              String   @id @default(uuid())
+  organisation_id String
+  name            String
+  code            String?
+  /// Global display order across departments within the org (drag-reorder in plan grid).
+  sort_order      Int      @default(0)
+  created_at      DateTime @default(now())
+  updated_at      DateTime @updatedAt
+  created_by      String
+  updated_by      String
+  is_active       Boolean  @default(true)
+
+  organisation      Organisation         @relation(fields: [organisation_id], references: [id], onDelete: Cascade, onUpdate: Cascade)
+  members           DepartmentMember[]
+  hiring_plan_lines HiringPlanLine[]
+  employees         Employee[]
+  job_descriptions  JobDescription[]
+  sections          HiringPlanSection[]
+
+  @@unique([organisation_id, name])
+  @@index([organisation_id])
+  @@schema("public")
+}
+
+/// Many-to-many membership: a user can belong to multiple departments.
+/// is_head marks the department head for that membership row. The same user can
+/// be head of multiple departments (multiple rows with is_head=true). At most
+/// one is_head=true per department is enforced in DepartmentService.
+model DepartmentMember {
+  id            String   @id @default(uuid())
+  department_id String
+  user_id       String
+  is_head       Boolean  @default(false)
+  created_at    DateTime @default(now())
+  updated_at    DateTime @updatedAt
+  created_by    String
+  updated_by    String
+  is_active     Boolean  @default(true)
+
+  department Department @relation(fields: [department_id], references: [id], onDelete: Cascade, onUpdate: Cascade)
+  user       User       @relation("DepartmentMemberships", fields: [user_id], references: [id], onDelete: Cascade, onUpdate: Cascade)
+
+  @@unique([department_id, user_id])
+  @@index([user_id])
+  @@index([department_id, is_head])
+  @@schema("public")
+}
+
+/// Per-department status for a specific hiring plan (submit → approve/lock).
+model HiringPlanSection {
+  id             String                  @id @default(uuid())
+  hiring_plan_id String
+  department_id  String
+  status         HiringPlanSectionStatus @default(DRAFT)
+  submitted_by   String?
+  submitted_at   DateTime?
+  approved_by    String?
+  approved_at    DateTime?
+  created_at     DateTime                @default(now())
+  updated_at     DateTime                @updatedAt
+  created_by     String
+  updated_by     String
+  is_active      Boolean                 @default(true)
+
+  hiring_plan HiringPlan @relation(fields: [hiring_plan_id], references: [id], onDelete: Cascade, onUpdate: Cascade)
+  department  Department @relation(fields: [department_id], references: [id], onDelete: Cascade, onUpdate: Cascade)
+
+  @@unique([hiring_plan_id, department_id])
+  @@index([hiring_plan_id])
+  @@index([department_id])
+  @@index([status])
+  @@schema("public")
+}

package/prisma/schema/hiringPlan.prisma

@@ -0,0 +1,197 @@
+enum HiringPlanStatus {
+  DRAFT
+  ACTIVE
+  CLOSED
+
+  @@schema("public")
+}
+
+enum PeriodType {
+  ANNUAL
+
+  @@schema("public")
+}
+
+enum EmployeeStatus {
+  ACTIVE
+  ATTRITION_EXPECTED
+  DEPARTED
+
+  @@schema("public")
+}
+
+enum AttritionRisk {
+  LOW
+  MEDIUM
+  HIGH
+
+  @@schema("public")
+}
+
+enum ReviewRating {
+  OUTSTANDING
+  EXCEEDS_EXPECTATIONS
+  MEETS_EXPECTATIONS
+  NEEDS_IMPROVEMENT
+  UNSATISFACTORY
+
+  @@schema("public")
+}
+
+enum PlannedCandidateStatus {
+  IDENTIFIED
+  IN_PIPELINE
+  OFFER
+  SELECTED
+  DECLINED
+
+  @@schema("public")
+}
+
+/// Org-level annual hiring plan (CHRO budgeting).
+model HiringPlan {
+  id                     String           @id @default(uuid())
+  organisation_id        String
+  fiscal_year            Int
+  period_type            PeriodType       @default(ANNUAL)
+  currency               String           @default("INR")
+  status                 HiringPlanStatus @default(DRAFT)
+  total_headcount_budget Int?
+  total_cost_budget      Decimal?         @db.Decimal(18, 2)
+  /// Workbook assumptions (multipliers, inflation, fiscal start month, etc.).
+  assumptions            Json?
+  notes                  String?
+  created_at             DateTime         @default(now())
+  updated_at             DateTime         @updatedAt
+  created_by             String
+  updated_by             String
+  is_active              Boolean          @default(true)
+
+  organisation Organisation        @relation(fields: [organisation_id], references: [id], onDelete: Cascade, onUpdate: Cascade)
+  lines        HiringPlanLine[]
+  sections     HiringPlanSection[]
+
+  @@unique([organisation_id, fiscal_year])
+  @@index([organisation_id])
+  @@index([status])
+  @@schema("public")
+}
+
+/// One allocation row: dimensions + planned headcount + monthly phasing inputs.
+model HiringPlanLine {
+  id                 String   @id @default(uuid())
+  hiring_plan_id     String
+  /// Owning department (grouping + section ownership). Legacy `business_unit` is
+  /// kept for back-compat and populated from Department.name for a while.
+  department_id      String?
+  business_unit      String?
+  level              String?
+  location           String?
+  role               String?
+  planned_headcount  Int      @default(1)
+  /// Fully-loaded annual run-rate cost per hire (not in-year cost).
+  cost_per_hire      Decimal  @db.Decimal(18, 2)
+  /// Fiscal month 1–12 when hires start (used when hire_schedule is null).
+  start_month        Int      @default(1)
+  /// Optional staggered starts: { "1": 2, "4": 2 } (fiscal-month → count).
+  hire_schedule      Json?
+  /// Display order within a business unit (lower first).
+  sort_order         Int      @default(0)
+  /// Reference/template JD for this role (definition).
+  job_description_id String?
+  created_at         DateTime @default(now())
+  updated_at         DateTime @updatedAt
+  created_by         String
+  updated_by         String
+  is_active          Boolean  @default(true)
+
+  hiring_plan             HiringPlan          @relation(fields: [hiring_plan_id], references: [id], onDelete: Cascade, onUpdate: Cascade)
+  department              Department?         @relation(fields: [department_id], references: [id], onDelete: SetNull, onUpdate: Cascade)
+  job_description         JobDescription?     @relation("PlanLineTemplateJd", fields: [job_description_id], references: [id], onDelete: SetNull, onUpdate: Cascade)
+  requisitions            JobDescription[]    @relation("PlanLineRequisitions")
+  budgets                 Budget[]
+  planned_candidates      PlannedCandidate[]
+  backfill_from_employees Employee[]          @relation("EmployeeBackfillLine")
+
+  @@index([hiring_plan_id])
+  @@index([department_id])
+  @@index([job_description_id])
+  @@index([business_unit, level, location, role])
+  @@schema("public")
+}
+
+/// Existing workforce roster (manual / CSV). Baseline for net-new vs backfill.
+model Employee {
+  id                    String         @id @default(uuid())
+  organisation_id       String
+  /// Owning department (Department.name mirrors legacy business_unit for back-compat).
+  department_id         String?
+  employee_code         String?
+  name                  String?
+  email                 String?
+  gender                String?
+  business_unit         String?
+  level                 String?
+  location              String?
+  role                  String?
+  employment_type       JobType?
+  starting_designation  String?
+  current_designation   String?
+  start_date            DateTime?
+  starting_salary       Decimal?       @db.Decimal(18, 2)
+  /// Comp immediately before the latest raise (or prior cycle). Optional.
+  previous_salary       Decimal?       @db.Decimal(18, 2)
+  current_comp          Decimal        @db.Decimal(18, 2)
+  currency              String         @default("INR")
+  last_increment_date   DateTime?
+  last_increment_amount Decimal?       @db.Decimal(18, 2)
+  last_increment_pct    Decimal?       @db.Decimal(8, 4)
+  last_review_date      DateTime?
+  last_review_rating    ReviewRating?
+  last_feedback_date    DateTime?
+  last_feedback_summary String?
+  status                EmployeeStatus @default(ACTIVE)
+  attrition_risk        AttritionRisk?
+  expected_exit_date    DateTime?
+  backfill_plan_line_id String?
+  created_at            DateTime       @default(now())
+  updated_at            DateTime       @updatedAt
+  created_by            String
+  updated_by            String
+  is_active             Boolean        @default(true)
+
+  organisation       Organisation    @relation(fields: [organisation_id], references: [id], onDelete: Cascade, onUpdate: Cascade)
+  department         Department?     @relation(fields: [department_id], references: [id], onDelete: SetNull, onUpdate: Cascade)
+  backfill_plan_line HiringPlanLine? @relation("EmployeeBackfillLine", fields: [backfill_plan_line_id], references: [id], onDelete: SetNull, onUpdate: Cascade)
+
+  @@unique([organisation_id, employee_code])
+  @@index([organisation_id])
+  @@index([department_id])
+  @@index([status])
+  @@index([business_unit, level, location, role])
+  @@index([backfill_plan_line_id])
+  @@schema("public")
+}
+
+/// Tentative candidate attached to a plan line (ATS CandidateProfile or free-text).
+model PlannedCandidate {
+  id                   String                 @id @default(uuid())
+  hiring_plan_line_id  String
+  candidate_profile_id String?
+  name                 String?
+  status               PlannedCandidateStatus @default(IDENTIFIED)
+  note                 String?
+  created_at           DateTime               @default(now())
+  updated_at           DateTime               @updatedAt
+  created_by           String
+  updated_by           String
+  is_active            Boolean                @default(true)
+
+  hiring_plan_line  HiringPlanLine    @relation(fields: [hiring_plan_line_id], references: [id], onDelete: Cascade, onUpdate: Cascade)
+  candidate_profile CandidateProfile? @relation(fields: [candidate_profile_id], references: [id], onDelete: SetNull, onUpdate: Cascade)
+
+  @@index([hiring_plan_line_id])
+  @@index([candidate_profile_id])
+  @@index([status])
+  @@schema("public")
+}

package/prisma/schema/jobDescription.prisma

@@ -11,6 +11,8 @@ enum JobDescriptionStatus {
 model JobDescription {
   id                            String               @id @default(uuid())
   organisation_id               String
+  /// Owning department (visibility scope for DepartmentHead; optional).
+  department_id                 String?
   hiring_manager_id             String?
   status                        JobDescriptionStatus @default(DRAFT)
   screeningQuestions            String[]
@@ -43,6 +45,7 @@ model JobDescription {
   job_profile_id           String?
   job_profile              JobProfile?             @relation(fields: [job_profile_id], references: [id], onDelete: SetNull, onUpdate: Cascade)
   organisation             Organisation            @relation(fields: [organisation_id], references: [id], onDelete: Cascade, onUpdate: Cascade)
+  department               Department?             @relation(fields: [department_id], references: [id], onDelete: SetNull, onUpdate: Cascade)
   source_document          Document?               @relation("SourceDocument", fields: [source_document_id], references: [id], onDelete: SetNull, onUpdate: Cascade)
   applications             Application[]
   interviews               Interview[]
@@ -62,9 +65,16 @@ model JobDescription {
   job_application_template JobApplicationTemplate?
   conversations            Conversation[]
   communication_messages   CommunicationMessage[]
+  /// Plan line this opening is committed against (requisition → plan).
+  hiring_plan_line_id      String?
+  hiring_plan_line         HiringPlanLine?         @relation("PlanLineRequisitions", fields: [hiring_plan_line_id], references: [id], onDelete: SetNull, onUpdate: Cascade)
+  /// Plan lines that use this JD as the role template/reference.
+  referenced_by_plan_lines HiringPlanLine[]        @relation("PlanLineTemplateJd")
 
   @@index([organisation_id])
   @@index([hiring_manager_id])
   @@index([job_profile_id])
+  @@index([hiring_plan_line_id])
+  @@index([department_id])
   @@schema("public")
 }

package/prisma/schema/migrations/20260610100000_add_communication/migration.sql

@@ -0,0 +1,131 @@
+-- CreateEnum
+CREATE TYPE "CommChannel" AS ENUM ('WHATSAPP', 'EMAIL', 'SMS', 'CALL');
+
+-- CreateEnum
+CREATE TYPE "CommProvider" AS ENUM ('META_WHATSAPP', 'TWILIO', 'GUPSHUP', 'MTALKZ', 'THREE_SIXTY_DIALOG', 'GMAIL', 'OUTLOOK', 'GENERIC_SMTP', 'GENERIC');
+
+-- CreateEnum
+CREATE TYPE "CommDirection" AS ENUM ('INBOUND', 'OUTBOUND');
+
+-- CreateEnum
+CREATE TYPE "CommMessageStatus" AS ENUM ('QUEUED', 'SENT', 'DELIVERED', 'READ', 'FAILED', 'RECEIVED');
+
+-- CreateTable
+CREATE TABLE "ChannelProviderConfig" (
+    "id" TEXT NOT NULL,
+    "organisation_id" TEXT NOT NULL,
+    "channel" "CommChannel" NOT NULL,
+    "provider" "CommProvider" NOT NULL,
+    "credentials" TEXT,
+    "metadata" JSONB NOT NULL DEFAULT '{}',
+    "is_active" BOOLEAN NOT NULL DEFAULT true,
+    "is_default" BOOLEAN NOT NULL DEFAULT true,
+    "created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updated_at" TIMESTAMP(3) NOT NULL,
+    "created_by" TEXT NOT NULL,
+    "updated_by" TEXT NOT NULL,
+
+    CONSTRAINT "ChannelProviderConfig_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "Conversation" (
+    "id" TEXT NOT NULL,
+    "organisation_id" TEXT NOT NULL,
+    "channel" "CommChannel" NOT NULL,
+    "provider" "CommProvider" NOT NULL,
+    "channel_provider_id" TEXT,
+    "external_id" TEXT NOT NULL,
+    "contact_user_id" TEXT,
+    "provider_thread_id" TEXT,
+    "subject" TEXT,
+    "status" TEXT NOT NULL DEFAULT 'open',
+    "unread_count" INTEGER NOT NULL DEFAULT 0,
+    "last_message_at" TIMESTAMP(3),
+    "metadata" JSONB NOT NULL DEFAULT '{}',
+    "created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updated_at" TIMESTAMP(3) NOT NULL,
+    "created_by" TEXT NOT NULL,
+    "updated_by" TEXT NOT NULL,
+
+    CONSTRAINT "Conversation_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "CommunicationMessage" (
+    "id" TEXT NOT NULL,
+    "conversation_id" TEXT NOT NULL,
+    "organisation_id" TEXT NOT NULL,
+    "channel" "CommChannel" NOT NULL,
+    "provider" "CommProvider" NOT NULL,
+    "channel_provider_id" TEXT,
+    "direction" "CommDirection" NOT NULL,
+    "status" "CommMessageStatus" NOT NULL,
+    "body" TEXT,
+    "from_identifier" TEXT NOT NULL,
+    "to_identifier" TEXT NOT NULL,
+    "sender_user_id" TEXT,
+    "provider_message_id" TEXT,
+    "template_name" TEXT,
+    "attachments" JSONB NOT NULL DEFAULT '[]',
+    "metadata" JSONB NOT NULL DEFAULT '{}',
+    "error" TEXT,
+    "sent_at" TIMESTAMP(3),
+    "delivered_at" TIMESTAMP(3),
+    "read_at" TIMESTAMP(3),
+    "created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updated_at" TIMESTAMP(3) NOT NULL,
+
+    CONSTRAINT "CommunicationMessage_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "ChannelProviderConfig_organisation_id_channel_provider_key" ON "ChannelProviderConfig"("organisation_id", "channel", "provider");
+
+-- CreateIndex
+CREATE INDEX "ChannelProviderConfig_organisation_id_channel_idx" ON "ChannelProviderConfig"("organisation_id", "channel");
+
+-- CreateIndex
+CREATE INDEX "ChannelProviderConfig_organisation_id_channel_is_active_idx" ON "ChannelProviderConfig"("organisation_id", "channel", "is_active");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "Conversation_organisation_id_channel_provider_external_id_key" ON "Conversation"("organisation_id", "channel", "provider", "external_id");
+
+-- CreateIndex
+CREATE INDEX "Conversation_organisation_id_channel_idx" ON "Conversation"("organisation_id", "channel");
+
+-- CreateIndex
+CREATE INDEX "Conversation_organisation_id_last_message_at_idx" ON "Conversation"("organisation_id", "last_message_at");
+
+-- CreateIndex
+CREATE INDEX "Conversation_external_id_idx" ON "Conversation"("external_id");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "CommunicationMessage_provider_provider_message_id_key" ON "CommunicationMessage"("provider", "provider_message_id");
+
+-- CreateIndex
+CREATE INDEX "CommunicationMessage_conversation_id_created_at_idx" ON "CommunicationMessage"("conversation_id", "created_at");
+
+-- CreateIndex
+CREATE INDEX "CommunicationMessage_organisation_id_channel_created_at_idx" ON "CommunicationMessage"("organisation_id", "channel", "created_at");
+
+-- CreateIndex
+CREATE INDEX "CommunicationMessage_organisation_id_status_idx" ON "CommunicationMessage"("organisation_id", "status");
+
+-- AddForeignKey
+ALTER TABLE "ChannelProviderConfig" ADD CONSTRAINT "ChannelProviderConfig_organisation_id_fkey" FOREIGN KEY ("organisation_id") REFERENCES "Organisation"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Conversation" ADD CONSTRAINT "Conversation_organisation_id_fkey" FOREIGN KEY ("organisation_id") REFERENCES "Organisation"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Conversation" ADD CONSTRAINT "Conversation_channel_provider_id_fkey" FOREIGN KEY ("channel_provider_id") REFERENCES "ChannelProviderConfig"("id") ON DELETE SET NULL ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "CommunicationMessage" ADD CONSTRAINT "CommunicationMessage_conversation_id_fkey" FOREIGN KEY ("conversation_id") REFERENCES "Conversation"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "CommunicationMessage" ADD CONSTRAINT "CommunicationMessage_organisation_id_fkey" FOREIGN KEY ("organisation_id") REFERENCES "Organisation"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "CommunicationMessage" ADD CONSTRAINT "CommunicationMessage_channel_provider_id_fkey" FOREIGN KEY ("channel_provider_id") REFERENCES "ChannelProviderConfig"("id") ON DELETE SET NULL ON UPDATE CASCADE;

package/prisma/schema/migrations/20260610170000_add_communication_application_scope/migration.sql

@@ -0,0 +1,45 @@
+-- AlterTable: Conversation
+ALTER TABLE "Conversation"
+  ADD COLUMN "application_id" TEXT,
+  ADD COLUMN "job_description_id" TEXT;
+
+-- AlterTable: CommunicationMessage
+ALTER TABLE "CommunicationMessage"
+  ADD COLUMN "application_id" TEXT,
+  ADD COLUMN "job_description_id" TEXT;
+
+-- CreateIndex
+CREATE INDEX "Conversation_organisation_id_application_id_idx" ON "Conversation"("organisation_id", "application_id");
+
+-- CreateIndex
+CREATE INDEX "Conversation_organisation_id_job_description_id_idx" ON "Conversation"("organisation_id", "job_description_id");
+
+-- CreateIndex
+CREATE INDEX "CommunicationMessage_organisation_id_application_id_idx" ON "CommunicationMessage"("organisation_id", "application_id");
+
+-- CreateIndex
+CREATE INDEX "CommunicationMessage_organisation_id_job_description_id_idx" ON "CommunicationMessage"("organisation_id", "job_description_id");
+
+-- AddForeignKey
+ALTER TABLE "Conversation"
+  ADD CONSTRAINT "Conversation_application_id_fkey"
+    FOREIGN KEY ("application_id") REFERENCES "Application"("id")
+    ON DELETE SET NULL ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Conversation"
+  ADD CONSTRAINT "Conversation_job_description_id_fkey"
+    FOREIGN KEY ("job_description_id") REFERENCES "JobDescription"("id")
+    ON DELETE SET NULL ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "CommunicationMessage"
+  ADD CONSTRAINT "CommunicationMessage_application_id_fkey"
+    FOREIGN KEY ("application_id") REFERENCES "Application"("id")
+    ON DELETE SET NULL ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "CommunicationMessage"
+  ADD CONSTRAINT "CommunicationMessage_job_description_id_fkey"
+    FOREIGN KEY ("job_description_id") REFERENCES "JobDescription"("id")
+    ON DELETE SET NULL ON UPDATE CASCADE;