@valentine-efagene/qshelter-common 2.0.36 → 2.0.38

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

@@ -39,6 +39,8 @@ export type * from './models/ContractPayment.js';
 export type * from './models/ContractDocument.js';
 export type * from './models/ContractTransition.js';
 export type * from './models/ContractEvent.js';
+export type * from './models/DocumentTemplate.js';
+export type * from './models/OfferLetter.js';
 export type * from './models/ContractTermination.js';
 export type * from './models/Prequalification.js';
 export type * from './models/PaymentMethodChangeRequest.js';

package/dist/src/events/notification-enums.d.ts

@@ -23,6 +23,9 @@ export declare enum NotificationType {
     CONTRACT_TERMINATION_REQUESTED = "contractTerminationRequested",
     CONTRACT_TERMINATION_APPROVED = "contractTerminationApproved",
     CONTRACT_TERMINATED = "contractTerminated",
+    OFFER_LETTER_SENT = "offerLetterSent",
+    OFFER_LETTER_SIGNED = "offerLetterSigned",
+    OFFER_LETTER_EXPIRED = "offerLetterExpired",
     ADMIN_CONTRIBUTION_RECEIVED = "adminContributionReceived",
     ADMIN_PROPERTY_ALLOCATION = "adminPropertyAllocation",
     ADMIN_INVITE = "adminInviteAdmin",

package/dist/src/events/notification-enums.js

@@ -30,6 +30,10 @@ export var NotificationType;
     NotificationType["CONTRACT_TERMINATION_REQUESTED"] = "contractTerminationRequested";
     NotificationType["CONTRACT_TERMINATION_APPROVED"] = "contractTerminationApproved";
     NotificationType["CONTRACT_TERMINATED"] = "contractTerminated";
+    // Offer Letters
+    NotificationType["OFFER_LETTER_SENT"] = "offerLetterSent";
+    NotificationType["OFFER_LETTER_SIGNED"] = "offerLetterSigned";
+    NotificationType["OFFER_LETTER_EXPIRED"] = "offerLetterExpired";
     // Admin
     NotificationType["ADMIN_CONTRIBUTION_RECEIVED"] = "adminContributionReceived";
     NotificationType["ADMIN_PROPERTY_ALLOCATION"] = "adminPropertyAllocation";

package/package.json

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

package/prisma/schema.prisma

@@ -151,9 +151,31 @@ enum CompletionCriterion {
 }
 
 enum DocumentStatus {
+  DRAFT
   PENDING
+  PENDING_SIGNATURE
+  SENT
+  VIEWED
+  SIGNED
   APPROVED
   REJECTED
+  EXPIRED
+  CANCELLED
+}
+
+enum OfferLetterType {
+  PROVISIONAL
+  FINAL
+}
+
+enum OfferLetterStatus {
+  DRAFT
+  GENERATED
+  SENT
+  VIEWED
+  SIGNED
+  EXPIRED
+  CANCELLED
 }
 
 // =============================================================================
@@ -209,6 +231,10 @@ model User {
   initiatedTerminations ContractTermination[] @relation("TerminationInitiator")
   reviewedTerminations  ContractTermination[] @relation("TerminationReviewer")
 
+  // Offer letters
+  offerLettersGenerated OfferLetter[] @relation("OfferLetterGenerator")
+  offerLettersSent      OfferLetter[] @relation("OfferLetterSender")
+
   @@index([email])
   @@index([tenantId])
   @@map("users")
@@ -286,6 +312,10 @@ model Tenant {
   // Contract terminations
   contractTerminations ContractTermination[]
 
+  // Offer letters and templates
+  documentTemplates DocumentTemplate[]
+  offerLetters      OfferLetter[]
+
   @@index([subdomain])
   @@map("tenants")
 }
@@ -895,6 +925,7 @@ model Contract {
   transitions  ContractTransition[]
   events       ContractEvent[]
   terminations ContractTermination[]
+  offerLetters OfferLetter[]
 
   // Prequalification that led to this contract (optional)
   prequalification            Prequalification?
@@ -1175,6 +1206,94 @@ model ContractEvent {
   @@map("contract_events")
 }
 
+// =============================================================================
+// OFFER LETTERS - Provisional and Final offer documents
+// =============================================================================
+
+model DocumentTemplate {
+  id       String @id @default(cuid())
+  tenantId String
+  tenant   Tenant @relation(fields: [tenantId], references: [id], onDelete: Cascade)
+
+  name        String // "Provisional Offer Letter", "Final Offer Letter"
+  code        String // PROVISIONAL_OFFER, FINAL_OFFER
+  description String?
+  version     Int    @default(1)
+
+  // Template content (Handlebars)
+  htmlTemplate String @db.Text
+  cssStyles    String? @db.Text
+
+  // Merge field definitions for UI
+  mergeFields Json? // [{name, type, required, description}]
+
+  isActive  Boolean @default(true)
+  isDefault Boolean @default(false)
+
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+
+  offerLetters OfferLetter[]
+
+  @@unique([tenantId, code, version])
+  @@index([tenantId])
+  @@index([code])
+  @@map("document_templates")
+}
+
+model OfferLetter {
+  id         String @id @default(cuid())
+  tenantId   String
+  tenant     Tenant @relation(fields: [tenantId], references: [id], onDelete: Cascade)
+  contractId String
+  contract   Contract @relation(fields: [contractId], references: [id], onDelete: Cascade)
+
+  // Template used
+  templateId String
+  template   DocumentTemplate @relation(fields: [templateId], references: [id])
+
+  // Letter details
+  letterNumber String           @unique // OL-XXXXXX
+  type         OfferLetterType
+  status       OfferLetterStatus @default(DRAFT)
+
+  // Generated document
+  htmlContent  String?  @db.Text // Rendered HTML
+  pdfUrl       String? // S3 URL of generated PDF
+  pdfKey       String? // S3 key for deletion/access
+
+  // Merge data used (snapshot for audit)
+  mergeData Json? // All data merged into template
+
+  // Signing workflow
+  sentAt      DateTime?
+  viewedAt    DateTime?
+  signedAt    DateTime?
+  signatureIp String?
+  signatureData Json? // {method, timestamp, metadata}
+
+  // Validity
+  expiresAt   DateTime?
+  expiredAt   DateTime?
+  cancelledAt DateTime?
+  cancelReason String?
+
+  // Audit
+  generatedById String?
+  generatedBy   User?   @relation("OfferLetterGenerator", fields: [generatedById], references: [id])
+  sentById      String?
+  sentBy        User?   @relation("OfferLetterSender", fields: [sentById], references: [id])
+
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+
+  @@index([tenantId])
+  @@index([contractId])
+  @@index([type])
+  @@index([status])
+  @@map("offer_letters")
+}
+
 // =============================================================================
 // CONTRACT TERMINATION - Full lifecycle for cancellation/termination
 // =============================================================================