@valentine-efagene/qshelter-common 2.0.29 → 2.0.31

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

@@ -7,6 +7,8 @@ export * from './ContractPayment';
 export * from './ContractPhase';
 export * from './ContractPhaseStep';
 export * from './ContractPhaseStepApproval';
+export * from './ContractPhaseStepDocument';
+export * from './ContractTermination';
 export * from './ContractTransition';
 export * from './DeviceEndpoint';
 export * from './DocumentRequirementRule';
@@ -15,6 +17,8 @@ export * from './EmailPreference';
 export * from './OAuthState';
 export * from './PasswordReset';
 export * from './PaymentMethodChangeRequest';
+export * from './PaymentMethodPhaseDocument';
+export * from './PaymentMethodPhaseStep';
 export * from './PaymentPlan';
 export * from './Permission';
 export * from './Prequalification';

package/dist/generated/client/models/index.js

@@ -7,6 +7,8 @@ export * from './ContractPayment';
 export * from './ContractPhase';
 export * from './ContractPhaseStep';
 export * from './ContractPhaseStepApproval';
+export * from './ContractPhaseStepDocument';
+export * from './ContractTermination';
 export * from './ContractTransition';
 export * from './DeviceEndpoint';
 export * from './DocumentRequirementRule';
@@ -15,6 +17,8 @@ export * from './EmailPreference';
 export * from './OAuthState';
 export * from './PasswordReset';
 export * from './PaymentMethodChangeRequest';
+export * from './PaymentMethodPhaseDocument';
+export * from './PaymentMethodPhaseStep';
 export * from './PaymentPlan';
 export * from './Permission';
 export * from './Prequalification';

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

@@ -27,15 +27,19 @@ export type * from './models/PaymentPlan.js';
 export type * from './models/PropertyPaymentMethod.js';
 export type * from './models/PropertyPaymentMethodLink.js';
 export type * from './models/PropertyPaymentMethodPhase.js';
+export type * from './models/PaymentMethodPhaseStep.js';
+export type * from './models/PaymentMethodPhaseDocument.js';
 export type * from './models/Contract.js';
 export type * from './models/ContractPhase.js';
 export type * from './models/ContractPhaseStep.js';
+export type * from './models/ContractPhaseStepDocument.js';
 export type * from './models/ContractPhaseStepApproval.js';
 export type * from './models/ContractInstallment.js';
 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/ContractTermination.js';
 export type * from './models/Prequalification.js';
 export type * from './models/PaymentMethodChangeRequest.js';
 export type * from './models/DocumentRequirementRule.js';

package/package.json

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

package/prisma/migrations/20260101081428_normalize_schema/migration.sql

@@ -0,0 +1,119 @@
+/*
+  Warnings:
+
+  - You are about to alter the column `status` on the `contract_documents` table. The data in that column could be lost. The data in that column will be cast from `VarChar(191)` to `Enum(EnumId(16))`.
+  - You are about to alter the column `status` on the `contract_installments` table. The data in that column could be lost. The data in that column will be cast from `VarChar(191)` to `Enum(EnumId(14))`.
+  - You are about to alter the column `status` on the `contract_payments` table. The data in that column could be lost. The data in that column will be cast from `VarChar(191)` to `Enum(EnumId(15))`.
+  - You are about to alter the column `decision` on the `contract_phase_step_approvals` table. The data in that column could be lost. The data in that column will be cast from `VarChar(191)` to `Enum(EnumId(13))`.
+  - You are about to drop the column `requiredDocumentTypes` on the `contract_phase_steps` table. All the data in the column will be lost.
+  - You are about to alter the column `stepType` on the `contract_phase_steps` table. The data in that column could be lost. The data in that column will be cast from `VarChar(191)` to `Enum(EnumId(11))`.
+  - You are about to alter the column `status` on the `contract_phase_steps` table. The data in that column could be lost. The data in that column will be cast from `VarChar(191)` to `Enum(EnumId(12))`.
+  - You are about to alter the column `phaseCategory` on the `contract_phases` table. The data in that column could be lost. The data in that column will be cast from `VarChar(191)` to `Enum(EnumId(7))`.
+  - You are about to alter the column `phaseType` on the `contract_phases` table. The data in that column could be lost. The data in that column will be cast from `VarChar(191)` to `Enum(EnumId(8))`.
+  - You are about to alter the column `status` on the `contract_phases` table. The data in that column could be lost. The data in that column will be cast from `VarChar(191)` to `Enum(EnumId(9))`.
+  - You are about to alter the column `status` on the `contracts` table. The data in that column could be lost. The data in that column will be cast from `VarChar(191)` to `Enum(EnumId(6))`.
+  - You are about to alter the column `state` on the `contracts` table. The data in that column could be lost. The data in that column will be cast from `VarChar(191)` to `Enum(EnumId(6))`.
+  - You are about to alter the column `paymentFrequency` on the `payment_plans` table. The data in that column could be lost. The data in that column will be cast from `VarChar(191)` to `Enum(EnumId(0))`.
+  - You are about to drop the column `requiredDocumentTypes` on the `property_payment_method_phases` table. All the data in the column will be lost.
+  - You are about to drop the column `stepDefinitions` on the `property_payment_method_phases` table. All the data in the column will be lost.
+  - You are about to alter the column `phaseCategory` on the `property_payment_method_phases` table. The data in that column could be lost. The data in that column will be cast from `VarChar(191)` to `Enum(EnumId(7))`.
+  - You are about to alter the column `phaseType` on the `property_payment_method_phases` table. The data in that column could be lost. The data in that column will be cast from `VarChar(191)` to `Enum(EnumId(8))`.
+
+*/
+-- AlterTable
+ALTER TABLE `contract_documents` MODIFY `status` ENUM('PENDING', 'APPROVED', 'REJECTED') NOT NULL DEFAULT 'PENDING';
+
+-- AlterTable
+ALTER TABLE `contract_installments` MODIFY `status` ENUM('PENDING', 'PAID', 'OVERDUE', 'PARTIALLY_PAID', 'WAIVED') NOT NULL DEFAULT 'PENDING';
+
+-- AlterTable
+ALTER TABLE `contract_payments` MODIFY `status` ENUM('INITIATED', 'PENDING', 'COMPLETED', 'FAILED', 'REFUNDED') NOT NULL DEFAULT 'INITIATED';
+
+-- AlterTable
+ALTER TABLE `contract_phase_step_approvals` MODIFY `decision` ENUM('APPROVED', 'REJECTED', 'REQUEST_CHANGES') NOT NULL;
+
+-- AlterTable
+ALTER TABLE `contract_phase_steps` DROP COLUMN `requiredDocumentTypes`,
+    MODIFY `stepType` ENUM('UPLOAD', 'REVIEW', 'SIGNATURE', 'APPROVAL', 'EXTERNAL_CHECK', 'WAIT') NOT NULL,
+    MODIFY `status` ENUM('PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'SKIPPED') NOT NULL DEFAULT 'PENDING';
+
+-- AlterTable
+ALTER TABLE `contract_phases` ADD COLUMN `approvedDocumentsCount` INTEGER NOT NULL DEFAULT 0,
+    ADD COLUMN `completedStepsCount` INTEGER NOT NULL DEFAULT 0,
+    ADD COLUMN `completionCriterion` ENUM('DOCUMENT_APPROVALS', 'PAYMENT_AMOUNT', 'STEPS_COMPLETED') NULL,
+    ADD COLUMN `paymentPlanSnapshot` JSON NULL,
+    ADD COLUMN `requiredDocumentSnapshot` JSON NULL,
+    ADD COLUMN `requiredDocumentsCount` INTEGER NOT NULL DEFAULT 0,
+    ADD COLUMN `stepDefinitionsSnapshot` JSON NULL,
+    ADD COLUMN `totalStepsCount` INTEGER NOT NULL DEFAULT 0,
+    MODIFY `phaseCategory` ENUM('DOCUMENTATION', 'PAYMENT') NOT NULL,
+    MODIFY `phaseType` ENUM('KYC', 'VERIFICATION', 'DOWNPAYMENT', 'MORTGAGE', 'BALLOON', 'CUSTOM') NOT NULL,
+    MODIFY `status` ENUM('PENDING', 'IN_PROGRESS', 'AWAITING_APPROVAL', 'ACTIVE', 'COMPLETED', 'SKIPPED', 'FAILED') NOT NULL DEFAULT 'PENDING';
+
+-- AlterTable
+ALTER TABLE `contracts` MODIFY `status` ENUM('DRAFT', 'PENDING', 'ACTIVE', 'COMPLETED', 'CANCELLED', 'TERMINATED') NOT NULL DEFAULT 'DRAFT',
+    MODIFY `state` ENUM('DRAFT', 'PENDING', 'ACTIVE', 'COMPLETED', 'CANCELLED', 'TERMINATED') NOT NULL DEFAULT 'DRAFT';
+
+-- AlterTable
+ALTER TABLE `payment_plans` MODIFY `paymentFrequency` ENUM('MONTHLY', 'BIWEEKLY', 'WEEKLY', 'ONE_TIME', 'CUSTOM') NOT NULL;
+
+-- AlterTable
+ALTER TABLE `property_payment_method_phases` DROP COLUMN `requiredDocumentTypes`,
+    DROP COLUMN `stepDefinitions`,
+    ADD COLUMN `completionCriterion` ENUM('DOCUMENT_APPROVALS', 'PAYMENT_AMOUNT', 'STEPS_COMPLETED') NULL,
+    ADD COLUMN `requiredDocumentSnapshot` JSON NULL,
+    ADD COLUMN `stepDefinitionsSnapshot` JSON NULL,
+    MODIFY `phaseCategory` ENUM('DOCUMENTATION', 'PAYMENT') NOT NULL,
+    MODIFY `phaseType` ENUM('KYC', 'VERIFICATION', 'DOWNPAYMENT', 'MORTGAGE', 'BALLOON', 'CUSTOM') NOT NULL;
+
+-- CreateTable
+CREATE TABLE `payment_method_phase_steps` (
+    `id` VARCHAR(191) NOT NULL,
+    `phaseId` VARCHAR(191) NOT NULL,
+    `name` VARCHAR(191) NOT NULL,
+    `stepType` ENUM('UPLOAD', 'REVIEW', 'SIGNATURE', 'APPROVAL', 'EXTERNAL_CHECK', 'WAIT') NOT NULL,
+    `order` INTEGER NOT NULL,
+    `metadata` JSON NULL,
+    `createdAt` DATETIME(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
+    `updatedAt` DATETIME(3) NOT NULL,
+
+    INDEX `payment_method_phase_steps_phaseId_idx`(`phaseId`),
+    PRIMARY KEY (`id`)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+
+-- CreateTable
+CREATE TABLE `payment_method_phase_documents` (
+    `id` VARCHAR(191) NOT NULL,
+    `phaseId` VARCHAR(191) NOT NULL,
+    `documentType` VARCHAR(191) NOT NULL,
+    `isRequired` BOOLEAN NOT NULL DEFAULT true,
+    `description` TEXT NULL,
+    `allowedMimeTypes` VARCHAR(191) NULL,
+    `maxSizeBytes` INTEGER NULL,
+    `metadata` JSON NULL,
+    `createdAt` DATETIME(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
+
+    INDEX `payment_method_phase_documents_phaseId_documentType_idx`(`phaseId`, `documentType`),
+    PRIMARY KEY (`id`)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+
+-- CreateTable
+CREATE TABLE `contract_phase_step_documents` (
+    `id` VARCHAR(191) NOT NULL,
+    `stepId` VARCHAR(191) NOT NULL,
+    `documentType` VARCHAR(191) NOT NULL,
+    `isRequired` BOOLEAN NOT NULL DEFAULT true,
+    `createdAt` DATETIME(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
+
+    INDEX `contract_phase_step_documents_stepId_documentType_idx`(`stepId`, `documentType`),
+    PRIMARY KEY (`id`)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+
+-- AddForeignKey
+ALTER TABLE `payment_method_phase_steps` ADD CONSTRAINT `payment_method_phase_steps_phaseId_fkey` FOREIGN KEY (`phaseId`) REFERENCES `property_payment_method_phases`(`id`) ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE `payment_method_phase_documents` ADD CONSTRAINT `payment_method_phase_documents_phaseId_fkey` FOREIGN KEY (`phaseId`) REFERENCES `property_payment_method_phases`(`id`) ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE `contract_phase_step_documents` ADD CONSTRAINT `contract_phase_step_documents_stepId_fkey` FOREIGN KEY (`stepId`) REFERENCES `contract_phase_steps`(`id`) ON DELETE CASCADE ON UPDATE CASCADE;

package/prisma/migrations/20260101102022_add_contract_termination/migration.sql

@@ -0,0 +1,69 @@
+-- CreateTable
+CREATE TABLE `contract_terminations` (
+    `id` VARCHAR(191) NOT NULL,
+    `contractId` VARCHAR(191) NOT NULL,
+    `tenantId` VARCHAR(191) NOT NULL,
+    `requestNumber` VARCHAR(191) NOT NULL,
+    `initiatedBy` ENUM('BUYER', 'SELLER', 'ADMIN', 'SYSTEM') NOT NULL,
+    `initiatorId` VARCHAR(191) NULL,
+    `type` ENUM('BUYER_WITHDRAWAL', 'SELLER_WITHDRAWAL', 'MUTUAL_AGREEMENT', 'PAYMENT_DEFAULT', 'DOCUMENT_FAILURE', 'FRAUD', 'FORCE_MAJEURE', 'PROPERTY_UNAVAILABLE', 'REGULATORY', 'OTHER') NOT NULL,
+    `reason` TEXT NULL,
+    `supportingDocs` JSON NULL,
+    `status` ENUM('REQUESTED', 'PENDING_REVIEW', 'PENDING_REFUND', 'REFUND_IN_PROGRESS', 'REFUND_COMPLETED', 'COMPLETED', 'REJECTED', 'CANCELLED') NOT NULL DEFAULT 'REQUESTED',
+    `requiresApproval` BOOLEAN NOT NULL DEFAULT true,
+    `autoApproveEligible` BOOLEAN NOT NULL DEFAULT false,
+    `reviewedBy` VARCHAR(191) NULL,
+    `reviewedAt` DATETIME(3) NULL,
+    `reviewNotes` TEXT NULL,
+    `rejectionReason` TEXT NULL,
+    `contractSnapshot` JSON NOT NULL,
+    `totalContractAmount` DOUBLE NOT NULL,
+    `totalPaidToDate` DOUBLE NOT NULL,
+    `outstandingBalance` DOUBLE NOT NULL,
+    `refundableAmount` DOUBLE NOT NULL DEFAULT 0,
+    `penaltyAmount` DOUBLE NOT NULL DEFAULT 0,
+    `forfeitedAmount` DOUBLE NOT NULL DEFAULT 0,
+    `adminFeeAmount` DOUBLE NOT NULL DEFAULT 0,
+    `netRefundAmount` DOUBLE NOT NULL DEFAULT 0,
+    `settlementNotes` TEXT NULL,
+    `refundStatus` ENUM('NOT_APPLICABLE', 'PENDING', 'INITIATED', 'PROCESSING', 'PARTIAL_COMPLETED', 'COMPLETED', 'FAILED') NOT NULL DEFAULT 'NOT_APPLICABLE',
+    `refundReference` VARCHAR(191) NULL,
+    `refundMethod` VARCHAR(191) NULL,
+    `refundAccountDetails` JSON NULL,
+    `refundInitiatedAt` DATETIME(3) NULL,
+    `refundCompletedAt` DATETIME(3) NULL,
+    `refundFailureReason` TEXT NULL,
+    `unitReleasedAt` DATETIME(3) NULL,
+    `unitReservedForId` VARCHAR(191) NULL,
+    `requestedAt` DATETIME(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
+    `approvedAt` DATETIME(3) NULL,
+    `executedAt` DATETIME(3) NULL,
+    `completedAt` DATETIME(3) NULL,
+    `cancelledAt` DATETIME(3) NULL,
+    `idempotencyKey` VARCHAR(191) NULL,
+    `metadata` JSON NULL,
+    `createdAt` DATETIME(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
+    `updatedAt` DATETIME(3) NOT NULL,
+
+    UNIQUE INDEX `contract_terminations_requestNumber_key`(`requestNumber`),
+    UNIQUE INDEX `contract_terminations_idempotencyKey_key`(`idempotencyKey`),
+    INDEX `contract_terminations_contractId_idx`(`contractId`),
+    INDEX `contract_terminations_tenantId_idx`(`tenantId`),
+    INDEX `contract_terminations_status_idx`(`status`),
+    INDEX `contract_terminations_type_idx`(`type`),
+    INDEX `contract_terminations_initiatorId_idx`(`initiatorId`),
+    INDEX `contract_terminations_requestedAt_idx`(`requestedAt`),
+    PRIMARY KEY (`id`)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+
+-- AddForeignKey
+ALTER TABLE `contract_terminations` ADD CONSTRAINT `contract_terminations_contractId_fkey` FOREIGN KEY (`contractId`) REFERENCES `contracts`(`id`) ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE `contract_terminations` ADD CONSTRAINT `contract_terminations_tenantId_fkey` FOREIGN KEY (`tenantId`) REFERENCES `tenants`(`id`) ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE `contract_terminations` ADD CONSTRAINT `contract_terminations_initiatorId_fkey` FOREIGN KEY (`initiatorId`) REFERENCES `users`(`id`) ON DELETE SET NULL ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE `contract_terminations` ADD CONSTRAINT `contract_terminations_reviewedBy_fkey` FOREIGN KEY (`reviewedBy`) REFERENCES `users`(`id`) ON DELETE SET NULL ON UPDATE CASCADE;