@valentine-efagene/qshelter-common 2.0.73 → 2.0.74

package/dist/generated/client/models.d.ts

@@ -52,4 +52,5 @@ export type * from './models/WorkflowEvent.js';
 export type * from './models/EventHandlerExecution.js';
 export type * from './models/DomainEvent.js';
 export type * from './models/PropertyTransferRequest.js';
+export type * from './models/ApprovalRequest.js';
 export type * from './commonInputTypes.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valentine-efagene/qshelter-common",
-  "version": "2.0.73",
+  "version": "2.0.74",
   "description": "Shared database schemas and utilities for QShelter services",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",

package/prisma/migrations/20260107172301_add_approval_request_model/migration.sql

@@ -0,0 +1,46 @@
+-- CreateTable
+CREATE TABLE `approval_requests` (
+    `id` VARCHAR(191) NOT NULL,
+    `tenantId` VARCHAR(191) NOT NULL,
+    `type` ENUM('PROPERTY_TRANSFER', 'PROPERTY_UPDATE', 'USER_WORKFLOW', 'CREDIT_CHECK', 'CONTRACT_TERMINATION', 'REFUND_APPROVAL') NOT NULL,
+    `status` ENUM('PENDING', 'IN_REVIEW', 'APPROVED', 'REJECTED', 'CANCELLED', 'EXPIRED') NOT NULL DEFAULT 'PENDING',
+    `priority` ENUM('LOW', 'NORMAL', 'HIGH', 'URGENT') NOT NULL DEFAULT 'NORMAL',
+    `entityType` VARCHAR(191) NOT NULL,
+    `entityId` VARCHAR(191) NOT NULL,
+    `title` VARCHAR(255) NOT NULL,
+    `description` TEXT NULL,
+    `payload` JSON NULL,
+    `requestedById` VARCHAR(191) NOT NULL,
+    `assigneeId` VARCHAR(191) NULL,
+    `reviewedById` VARCHAR(191) NULL,
+    `reviewNotes` TEXT NULL,
+    `decision` ENUM('APPROVED', 'REJECTED', 'REQUEST_CHANGES') NULL,
+    `expiresAt` DATETIME(3) NULL,
+    `createdAt` DATETIME(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
+    `assignedAt` DATETIME(3) NULL,
+    `reviewedAt` DATETIME(3) NULL,
+    `completedAt` DATETIME(3) NULL,
+    `updatedAt` DATETIME(3) NOT NULL,
+
+    INDEX `approval_requests_tenantId_idx`(`tenantId`),
+    INDEX `approval_requests_type_idx`(`type`),
+    INDEX `approval_requests_status_idx`(`status`),
+    INDEX `approval_requests_priority_idx`(`priority`),
+    INDEX `approval_requests_entityType_entityId_idx`(`entityType`, `entityId`),
+    INDEX `approval_requests_requestedById_idx`(`requestedById`),
+    INDEX `approval_requests_assigneeId_idx`(`assigneeId`),
+    INDEX `approval_requests_createdAt_idx`(`createdAt`),
+    PRIMARY KEY (`id`)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+
+-- AddForeignKey
+ALTER TABLE `approval_requests` ADD CONSTRAINT `approval_requests_tenantId_fkey` FOREIGN KEY (`tenantId`) REFERENCES `tenants`(`id`) ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE `approval_requests` ADD CONSTRAINT `approval_requests_requestedById_fkey` FOREIGN KEY (`requestedById`) REFERENCES `users`(`id`) ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE `approval_requests` ADD CONSTRAINT `approval_requests_assigneeId_fkey` FOREIGN KEY (`assigneeId`) REFERENCES `users`(`id`) ON DELETE SET NULL ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE `approval_requests` ADD CONSTRAINT `approval_requests_reviewedById_fkey` FOREIGN KEY (`reviewedById`) REFERENCES `users`(`id`) ON DELETE SET NULL ON UPDATE CASCADE;

package/prisma/schema.prisma

@@ -306,6 +306,11 @@ model User {
   transferRequestsSubmitted PropertyTransferRequest[] @relation("TransferRequestor")
   transferRequestsReviewed  PropertyTransferRequest[] @relation("TransferReviewer")
 
+  // Unified approval requests
+  approvalRequestsSubmitted ApprovalRequest[] @relation("ApprovalRequestor")
+  approvalRequestsAssigned  ApprovalRequest[] @relation("ApprovalAssignee")
+  approvalRequestsReviewed  ApprovalRequest[] @relation("ApprovalReviewer")
+
   @@index([email])
   @@index([tenantId])
   @@map("users")
@@ -398,6 +403,9 @@ model Tenant {
   // Property transfer requests
   propertyTransferRequests PropertyTransferRequest[]
 
+  // Unified approval requests
+  approvalRequests ApprovalRequest[]
+
   @@index([subdomain])
   @@map("tenants")
 }
@@ -2064,3 +2072,91 @@ model PropertyTransferRequest {
   @@index([status])
   @@map("property_transfer_requests")
 }
+
+// =============================================================================
+// UNIFIED APPROVAL REQUESTS
+// =============================================================================
+
+enum ApprovalRequestType {
+  PROPERTY_TRANSFER    // Property unit transfer between contracts
+  PROPERTY_UPDATE      // Property/unit listing update requiring approval
+  USER_WORKFLOW        // User workflow step approval
+  CREDIT_CHECK         // Credit check result review
+  CONTRACT_TERMINATION // Contract termination approval
+  REFUND_APPROVAL      // Refund request approval
+}
+
+enum ApprovalRequestStatus {
+  PENDING      // Awaiting review
+  IN_REVIEW    // Assigned to reviewer
+  APPROVED     // Approved by reviewer
+  REJECTED     // Rejected by reviewer
+  CANCELLED    // Cancelled by requestor
+  EXPIRED      // Auto-expired (if TTL configured)
+}
+
+enum ApprovalRequestPriority {
+  LOW
+  NORMAL
+  HIGH
+  URGENT
+}
+
+// Polymorphic approval request model for unified admin dashboard
+model ApprovalRequest {
+  id       String @id @default(cuid())
+  tenantId String
+  tenant   Tenant @relation(fields: [tenantId], references: [id], onDelete: Cascade)
+
+  // Request type and status
+  type     ApprovalRequestType
+  status   ApprovalRequestStatus   @default(PENDING)
+  priority ApprovalRequestPriority @default(NORMAL)
+
+  // Polymorphic reference to the entity requiring approval
+  entityType String // e.g., "PropertyTransferRequest", "PropertyUnit", "User"
+  entityId   String // ID of the referenced entity
+
+  // Request metadata
+  title       String  @db.VarChar(255) // Human-readable title for the request
+  description String? @db.Text        // Detailed description
+
+  // Payload for any additional context (JSON)
+  payload Json? // Flexible data storage for type-specific details
+
+  // Requestor - who created the request
+  requestedById String
+  requestedBy   User   @relation("ApprovalRequestor", fields: [requestedById], references: [id])
+
+  // Assignee - admin/reviewer assigned to handle this request
+  assigneeId String?
+  assignee   User?   @relation("ApprovalAssignee", fields: [assigneeId], references: [id])
+
+  // Reviewer - who made the final decision (may differ from assignee)
+  reviewedById String?
+  reviewedBy   User?   @relation("ApprovalReviewer", fields: [reviewedById], references: [id])
+
+  // Review details
+  reviewNotes String? @db.Text // Reviewer's notes/comments
+  decision    ApprovalDecision? // APPROVED, REJECTED, REQUEST_CHANGES
+
+  // Expiration
+  expiresAt DateTime? // Optional TTL for auto-expiration
+
+  // Timestamps
+  createdAt   DateTime  @default(now())
+  assignedAt  DateTime? // When assigned to reviewer
+  reviewedAt  DateTime? // When decision was made
+  completedAt DateTime? // When fully processed
+  updatedAt   DateTime  @updatedAt
+
+  @@index([tenantId])
+  @@index([type])
+  @@index([status])
+  @@index([priority])
+  @@index([entityType, entityId])
+  @@index([requestedById])
+  @@index([assigneeId])
+  @@index([createdAt])
+  @@map("approval_requests")
+}