vr-models 1.0.56 → 1.0.58

package/dist/models/contact.models.d.ts

@@ -0,0 +1,71 @@
+import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute, ModelStatic } from "vr-migrations";
+import type { User } from "./user.models";
+export declare const CONTACT_TYPES: readonly ["EMAIL", "PHONE", "WHATSAPP"];
+export type ContactType = (typeof CONTACT_TYPES)[number];
+export interface VerificationMetadata {
+    lastOtpSentAt?: Date;
+    otpAttempts?: number;
+    lastFailedAttemptAt?: Date;
+    isLocked?: boolean;
+    lockedUntil: Date | null;
+    carrier?: string;
+    countryCode?: string;
+    deactivatedAt?: Date | null;
+    deactivationReason?: string;
+    verificationToken?: string | null;
+    tokenExpiresAt?: Date | null;
+}
+export interface ContactAttributes {
+    id: string;
+    contactValue: string;
+    type: ContactType;
+    userId: string | null;
+    isVerified: boolean;
+    verifiedAt: Date | null;
+    isPrimary: boolean;
+    isActive: boolean;
+    otp: string | null;
+    otpExpiresAt: Date | null;
+    metadata: VerificationMetadata;
+    createdAt: Date;
+    updatedAt: Date;
+    user?: NonAttribute<User>;
+}
+export interface ContactCreationAttributes extends Omit<ContactAttributes, "id" | "createdAt" | "updatedAt" | "metadata"> {
+    id?: string;
+    metadata?: Partial<VerificationMetadata>;
+}
+export declare class Contact extends Model<InferAttributes<Contact>, InferCreationAttributes<Contact>> implements ContactAttributes {
+    id: CreationOptional<string>;
+    contactValue: string;
+    type: ContactType;
+    userId: CreationOptional<string | null>;
+    isVerified: CreationOptional<boolean>;
+    verifiedAt: CreationOptional<Date | null>;
+    isPrimary: CreationOptional<boolean>;
+    isActive: CreationOptional<boolean>;
+    otp: CreationOptional<string | null>;
+    otpExpiresAt: CreationOptional<Date | null>;
+    metadata: CreationOptional<VerificationMetadata>;
+    readonly createdAt: CreationOptional<Date>;
+    readonly updatedAt: CreationOptional<Date>;
+    user?: NonAttribute<User>;
+    static initialize(sequelize: any): void;
+    static associate(models: Record<string, ModelStatic<Model>>): void;
+    deactivate(reason?: string): Promise<void>;
+    reactivate(): Promise<void>;
+    markAsVerified(): Promise<void>;
+    isLocked(): boolean;
+    getRemainingLockTime(): number | null;
+    isExpired(): boolean;
+    getRemainingOTPTime(): number | null;
+    static findByContactValue(contactValue: string, type: ContactType): Promise<Contact | null>;
+    static findVerifiedByContactValue(contactValue: string, type: ContactType): Promise<Contact | null>;
+    static getUserContacts(userId: string): Promise<Contact[]>;
+    static getUserPrimaryContact(userId: string): Promise<Contact | null>;
+    static isContactAvailable(contactValue: string, type: ContactType): Promise<boolean>;
+    static cleanupExpiredOTPs(): Promise<void>;
+    getDisplayValue(): string;
+    getVerificationMethod(): string;
+}
+export type ContactModel = typeof Contact;

package/dist/models/{phoneContact.models.js → contact.models.js}

@@ -1,8 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PhoneContact = void 0;
+exports.Contact = exports.CONTACT_TYPES = void 0;
+// src/models/contact.models.ts
 const vr_migrations_1 = require("vr-migrations");
-class PhoneContact extends vr_migrations_1.Model {
+// ==================== CONTACT TYPES ====================
+exports.CONTACT_TYPES = ["EMAIL", "PHONE", "WHATSAPP"];
+class Contact extends vr_migrations_1.Model {
     // Static initialization method
     static initialize(sequelize) {
         this.init({
@@ -12,13 +15,13 @@ class PhoneContact extends vr_migrations_1.Model {
                 primaryKey: true,
                 allowNull: false,
             },
-            phoneNumber: {
-                type: vr_migrations_1.DataTypes.STRING(20),
+            contactValue: {
+                type: vr_migrations_1.DataTypes.STRING(255),
+                allowNull: false,
+            },
+            type: {
+                type: vr_migrations_1.DataTypes.ENUM("EMAIL", "PHONE", "WHATSAPP"),
                 allowNull: false,
-                unique: true,
-                validate: {
-                    is: /^\+?[0-9]{10,15}$/,
-                },
             },
             userId: {
                 type: vr_migrations_1.DataTypes.UUID,
@@ -79,27 +82,47 @@ class PhoneContact extends vr_migrations_1.Model {
             },
         }, {
             sequelize,
-            modelName: "PhoneContact",
-            tableName: "phone_contacts",
+            modelName: "Contact",
+            tableName: "contacts",
             timestamps: true,
             freezeTableName: true,
+            validate: {
+                validContactValue() {
+                    if (this.type === "EMAIL") {
+                        const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+                        if (!emailRegex.test(this.contactValue)) {
+                            throw new Error("Invalid email address format");
+                        }
+                    }
+                    else if (this.type === "PHONE" || this.type === "WHATSAPP") {
+                        const phoneRegex = /^\+?[0-9]{10,15}$/;
+                        if (!phoneRegex.test(this.contactValue)) {
+                            throw new Error("Invalid phone number format");
+                        }
+                    }
+                },
+            },
             indexes: [
                 {
                     unique: true,
-                    fields: ["phoneNumber"],
-                    name: "phone_contacts_phone_number_unique",
+                    fields: ["contactValue", "type"],
+                    name: "contacts_unique_value_type_idx",
                 },
                 {
                     fields: ["userId"],
-                    name: "phone_contacts_user_id_idx",
+                    name: "contacts_user_id_idx",
+                },
+                {
+                    fields: ["type"],
+                    name: "contacts_type_idx",
                 },
                 {
                     fields: ["isVerified", "isPrimary"],
-                    name: "phone_contacts_verified_primary_idx",
+                    name: "contacts_verified_primary_idx",
                 },
                 {
                     fields: ["otpExpiresAt"],
-                    name: "phone_contacts_otp_expiry_idx",
+                    name: "contacts_otp_expiry_idx",
                 },
             ],
         });
@@ -113,6 +136,9 @@ class PhoneContact extends vr_migrations_1.Model {
             onUpdate: "CASCADE",
         });
     }
+    // ===========================================================================
+    // INSTANCE METHODS
+    // ===========================================================================
     async deactivate(reason) {
         this.isActive = false;
         this.metadata = {
@@ -131,6 +157,13 @@ class PhoneContact extends vr_migrations_1.Model {
         };
         await this.save();
     }
+    async markAsVerified() {
+        this.isVerified = true;
+        this.verifiedAt = new Date();
+        this.otp = null;
+        this.otpExpiresAt = null;
+        await this.save();
+    }
     isLocked() {
         if (!this.metadata.isLocked)
             return false;
@@ -161,34 +194,37 @@ class PhoneContact extends vr_migrations_1.Model {
         const remaining = new Date(this.otpExpiresAt).getTime() - new Date().getTime();
         return Math.max(0, Math.ceil(remaining / 1000));
     }
-    // Static methods
-    static async findByPhoneNumber(phoneNumber) {
-        return await this.findOne({
-            where: { phoneNumber },
-        });
-    }
-    static async findVerifiedByPhoneNumber(phoneNumber) {
+    // ===========================================================================
+    // STATIC METHODS
+    // ===========================================================================
+    static async findByContactValue(contactValue, type) {
         return await this.findOne({
-            where: { phoneNumber, isVerified: true, isActive: true },
+            where: { contactValue, type },
         });
     }
-    static async getUserPrimaryPhone(userId) {
+    static async findVerifiedByContactValue(contactValue, type) {
         return await this.findOne({
-            where: { userId, isPrimary: true, isActive: true },
+            where: { contactValue, type, isVerified: true, isActive: true },
         });
     }
-    static async getUserPhones(userId) {
+    static async getUserContacts(userId) {
         return await this.findAll({
             where: { userId, isActive: true },
             order: [
                 ["isPrimary", "DESC"],
+                ["type", "ASC"],
                 ["createdAt", "ASC"],
             ],
         });
     }
-    static async isPhoneNumberAvailable(phoneNumber) {
+    static async getUserPrimaryContact(userId) {
+        return await this.findOne({
+            where: { userId, isPrimary: true, isActive: true },
+        });
+    }
+    static async isContactAvailable(contactValue, type) {
         const existing = await this.findOne({
-            where: { phoneNumber, isVerified: true },
+            where: { contactValue, type, isVerified: true },
         });
         return !existing;
     }
@@ -200,5 +236,33 @@ class PhoneContact extends vr_migrations_1.Model {
             },
         });
     }
+    // ===========================================================================
+    // TYPE-SPECIFIC HELPERS
+    // ===========================================================================
+    getDisplayValue() {
+        if (this.type === "EMAIL") {
+            return this.contactValue;
+        }
+        else if (this.type === "PHONE" || this.type === "WHATSAPP") {
+            // Mask phone number
+            const phone = this.contactValue;
+            if (phone.length <= 4)
+                return phone;
+            return phone.slice(0, 3) + "****" + phone.slice(-3);
+        }
+        return this.contactValue;
+    }
+    getVerificationMethod() {
+        switch (this.type) {
+            case "EMAIL":
+                return "email";
+            case "PHONE":
+                return "sms";
+            case "WHATSAPP":
+                return "whatsapp";
+            default:
+                return "unknown";
+        }
+    }
 }
-exports.PhoneContact = PhoneContact;
+exports.Contact = Contact;

package/dist/models/devicePaymentPlan.models.d.ts

@@ -2,6 +2,7 @@ import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonA
 import type { Device } from "./device.models";
 import type { User } from "./user.models";
 import type { Installment } from "./installment.models";
+import { Payment } from "./payment.models";
 export type PaymentPlanStatus = "ACTIVE" | "COMPLETED" | "DEFAULTED" | "CANCELLED";
 export declare const PAYMENT_PLAN_STATUS: readonly ["ACTIVE", "COMPLETED", "DEFAULTED", "CANCELLED"];
 export interface DevicePaymentPlanAttributes {
@@ -19,6 +20,7 @@ export interface DevicePaymentPlanAttributes {
     devices?: Device[];
     user: User;
     installments?: Installment[];
+    payment?: Payment;
 }
 export interface DevicePaymentPlanCreationAttributes extends Omit<DevicePaymentPlanAttributes, "id" | "createdAt" | "updatedAt" | "paidAmount" | "outstandingAmount" | "lastPaymentAt" | "nextInstallmentDueAt" | "status" | "completedAt" | "devices" | "installments"> {
     id?: string;
@@ -41,6 +43,7 @@ export declare class DevicePaymentPlan extends Model<InferAttributes<DevicePayme
     devices?: NonAttribute<Device[]>;
     user: NonAttribute<User>;
     installments?: NonAttribute<Installment[]>;
+    payment?: NonAttribute<Payment>;
     static initialize(sequelize: any): void;
     static associate(models: Record<string, ModelStatic<Model>>): void;
     updateProgress(): Promise<void>;

package/dist/models/devicePaymentPlan.models.js

@@ -91,6 +91,13 @@ class DevicePaymentPlan extends vr_migrations_1.Model {
             onDelete: "SET NULL", // ← This is SET NULL, not CASCADE
             onUpdate: "CASCADE",
         });
+        // One-to-One with Payment (down payment/full payment upfront)
+        this.hasOne(models.Payment, {
+            foreignKey: "devicePaymentPlanId",
+            as: "downPayment", // DevicePaymentPlan.getDownPayment()
+            onDelete: "SET NULL",
+            onUpdate: "CASCADE",
+        });
     }
     // Custom instance methods
     async updateProgress() {

package/dist/models/index.d.ts

@@ -7,10 +7,10 @@ export * from "./payment.models";
 export * from "./pricing.models";
 export * from "./product.models";
 export * from "./securityClearance.models";
-export * from "./transaction.models";
+export * from "./paymentEventLog.models";
 export * from "./installment.models";
 export * from "./ban.models";
 export * from "./suspension.models";
 export * from "./appSpecs.models";
-export * from "./phoneContact.models";
-export type { UserModel, TransactionModel, SecurityClearanceModel, ProductModel, PricingModel, PaymentModel, IdempotencyRecordModel, EventLogModel, DevicePaymentPlanModel, DeviceModel, InstallmentModel, BanModel, SuspensionModel, AppSpecsModel, PhoneContactModel, } from "./types";
+export * from "./contact.models";
+export type { UserModel, SecurityClearanceModel, ProductModel, PricingModel, PaymentModel, PaymentEventLogModel, IdempotencyRecordModel, EventLogModel, DevicePaymentPlanModel, DeviceModel, InstallmentModel, BanModel, SuspensionModel, AppSpecsModel, ContactModel, } from "./types";

package/dist/models/index.js

@@ -23,9 +23,9 @@ __exportStar(require("./payment.models"), exports);
 __exportStar(require("./pricing.models"), exports);
 __exportStar(require("./product.models"), exports);
 __exportStar(require("./securityClearance.models"), exports);
-__exportStar(require("./transaction.models"), exports);
+__exportStar(require("./paymentEventLog.models"), exports);
 __exportStar(require("./installment.models"), exports);
 __exportStar(require("./ban.models"), exports);
 __exportStar(require("./suspension.models"), exports);
 __exportStar(require("./appSpecs.models"), exports);
-__exportStar(require("./phoneContact.models"), exports);
+__exportStar(require("./contact.models"), exports);

package/dist/models/payment.models.d.ts

@@ -1,65 +1,84 @@
 import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute, ModelStatic } from "vr-migrations";
 import type { User } from "./user.models";
 import type { DevicePaymentPlan } from "./devicePaymentPlan.models";
-import type { Transaction } from "./transaction.models";
+import type { Installment } from "./installment.models";
 import type { IdempotencyRecord } from "./idempotencyRecord.models";
-export type PaymentProvider = "mtn_momo" | "airtel_money";
-export type PaymentStatus = "PENDING" | "SUCCESSFUL" | "FAILED";
-export declare const PAYMENT_PROVIDER: readonly ["mtn_momo", "airtel_money"];
-export declare const PAYMENT_STATUS: readonly ["PENDING", "SUCCESSFUL", "FAILED"];
+import { PaymentEventLog } from "./paymentEventLog.models";
+export type PaymentProvider = "MTN_MOMO" | "AIRTEL_MONEY" | "DPO" | "FLUTTERWAVE";
+export type PaymentStatus = "PENDING" | "SUCCESSFUL" | "FAILED" | "REFUNDED";
+export declare const PAYMENT_PROVIDER: readonly ["MTN_MOMO", "AIRTEL_MONEY", "DPO", "FLUTTERWAVE"];
+export declare const PAYMENT_STATUS: readonly ["PENDING", "SUCCESSFUL", "FAILED", "REFUNDED"];
 export interface PaymentAttributes {
     id: string;
     userId: string;
-    devicePaymentPlanId: string;
-    transactionId: string | null;
+    devicePaymentPlanId: string | null;
+    installmentId: string | null;
     idempotencyKeyId: string | null;
     amount: number;
+    currency: string;
     provider: PaymentProvider;
     providerReference: string | null;
     status: PaymentStatus;
+    customerPhone: string;
+    customerName: string | null;
+    failureReason: string | null;
     metadata: Record<string, any>;
+    settledAt: Date | null;
     createdAt: Date;
     updatedAt: Date;
     user?: User;
     devicePaymentPlan?: DevicePaymentPlan;
-    transaction?: Transaction;
+    installment?: Installment;
     idempotencyKey?: IdempotencyRecord;
+    paymentEventLogs?: PaymentEventLog[];
 }
-export interface PaymentCreationAttributes extends Omit<PaymentAttributes, "id" | "createdAt" | "updatedAt" | "status" | "providerReference" | "metadata" | "transactionId" | "idempotencyKeyId"> {
+export interface PaymentCreationAttributes extends Omit<PaymentAttributes, "id" | "createdAt" | "updatedAt" | "status" | "providerReference" | "failureReason" | "settledAt" | "metadata"> {
     id?: string;
     status?: PaymentStatus;
     providerReference?: string | null;
+    failureReason?: string | null;
+    settledAt?: Date | null;
     metadata?: Record<string, any>;
-    transactionId?: string | null;
-    idempotencyKeyId?: string | null;
 }
 export declare class Payment extends Model<InferAttributes<Payment>, InferCreationAttributes<Payment>> implements PaymentAttributes {
     id: CreationOptional<string>;
     userId: string;
-    devicePaymentPlanId: string;
-    transactionId: CreationOptional<string | null>;
+    devicePaymentPlanId: CreationOptional<string | null>;
+    installmentId: CreationOptional<string | null>;
     idempotencyKeyId: CreationOptional<string | null>;
     amount: number;
+    currency: string;
     provider: PaymentProvider;
     providerReference: CreationOptional<string | null>;
     status: PaymentStatus;
+    customerPhone: string;
+    customerName: CreationOptional<string | null>;
+    failureReason: CreationOptional<string | null>;
     metadata: CreationOptional<Record<string, any>>;
+    settledAt: CreationOptional<Date | null>;
     readonly createdAt: CreationOptional<Date>;
     readonly updatedAt: CreationOptional<Date>;
     user?: NonAttribute<User>;
     devicePaymentPlan?: NonAttribute<DevicePaymentPlan>;
-    transaction?: NonAttribute<Transaction>;
+    installment?: NonAttribute<Installment>;
     idempotencyKey?: NonAttribute<IdempotencyRecord>;
+    paymentEventLogs?: NonAttribute<PaymentEventLog[]>;
     static initialize(sequelize: any): void;
     static associate(models: Record<string, ModelStatic<Model>>): void;
-    markAsSucceeded(providerReference: string, metadata?: Record<string, any>): Promise<void>;
+    markAsSuccessful(providerReference: string, metadata?: Record<string, any>): Promise<void>;
     markAsFailed(reason: string, metadata?: Record<string, any>): Promise<void>;
-    process(transactionId: string, idempotencyKeyId?: string): Promise<void>;
+    markAsRefunded(metadata?: Record<string, any>): Promise<void>;
+    markAsSettled(settledAt?: Date): Promise<void>;
     isSuccessful(): boolean;
     isPending(): boolean;
     isFailed(): boolean;
-    getProviderDisplayName(): string;
+    isRefunded(): boolean;
+    getFormattedAmount(): string;
+    getTargetType(): "payment_plan" | "installment";
+    getTargetId(): string;
     static getUserPayments(userId: string, limit?: number): Promise<Payment[]>;
-    static getPaymentPlanPayments(devicePaymentPlanId: string): Promise<Payment[]>;
+    static getPlanPayments(planId: string): Promise<Payment[]>;
+    static getInstallmentPayments(installmentId: string): Promise<Payment[]>;
+    static getPendingPayments(): Promise<Payment[]>;
 }
 export type PaymentModel = typeof Payment;