vr-models 1.0.15 → 1.0.17

package/dist/models/device.models.d.ts

@@ -3,12 +3,11 @@ import type { Product } from "./product.models";
 import type { DevicePaymentPlan } from "./devicePaymentPlan.models";
 export type DeviceStatus = "locked" | "unlocked" | "disabled";
 export type DeviceDedication = "PASSENGER" | "RIDER" | "N/A";
-export declare const DEVICE_STATUS: readonly ["locked", "unlocked", "disabled"];
-export declare const DEDICATED_USER: readonly ["RIDER", "PASSENGER", "N/A"];
 export interface DeviceAttributes {
     id: string;
     serialNumber: string;
     productId: string;
+    devicePaymentPlanId: string | null;
     status: DeviceStatus;
     isPermanentlyUnlocked: boolean;
     dedicatedUser: DeviceDedication;
@@ -16,17 +15,19 @@ export interface DeviceAttributes {
     createdAt: Date;
     updatedAt: Date;
     product?: Product;
-    paymentPlans?: DevicePaymentPlan[];
+    paymentPlan?: DevicePaymentPlan;
 }
-export interface DeviceCreationAttributes extends Omit<DeviceAttributes, "id" | "createdAt" | "updatedAt" | "status" | "isPermanentlyUnlocked"> {
+export interface DeviceCreationAttributes extends Omit<DeviceAttributes, "id" | "createdAt" | "updatedAt" | "status" | "isPermanentlyUnlocked" | "devicePaymentPlanId"> {
     id?: string;
     status?: DeviceStatus;
     isPermanentlyUnlocked?: boolean;
+    devicePaymentPlanId?: string | null;
 }
 export declare class Device extends Model<InferAttributes<Device>, InferCreationAttributes<Device>> implements DeviceAttributes {
     id: CreationOptional<string>;
     serialNumber: string;
     productId: string;
+    devicePaymentPlanId: CreationOptional<string | null>;
     status: CreationOptional<DeviceStatus>;
     isPermanentlyUnlocked: CreationOptional<boolean>;
     dedicatedUser: DeviceDedication;
@@ -34,7 +35,7 @@ export declare class Device extends Model<InferAttributes<Device>, InferCreation
     readonly createdAt: CreationOptional<Date>;
     readonly updatedAt: CreationOptional<Date>;
     product?: NonAttribute<Product>;
-    paymentPlans?: NonAttribute<DevicePaymentPlan[]>;
+    paymentPlan?: NonAttribute<DevicePaymentPlan>;
     static initialize(sequelize: any): void;
     static associate(models: Record<string, ModelStatic<Model>>): void;
     activate(): Promise<void>;
@@ -44,5 +45,7 @@ export declare class Device extends Model<InferAttributes<Device>, InferCreation
     makePermanent(): Promise<void>;
     isActive(): boolean;
     canBeActivated(): boolean;
+    isAssigned(): boolean;
+    getPaymentPlan(): Promise<DevicePaymentPlan | null>;
 }
 export type DeviceModel = typeof Device;

package/dist/models/device.models.js

@@ -1,10 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Device = exports.DEDICATED_USER = exports.DEVICE_STATUS = void 0;
+exports.Device = void 0;
 // src/models/device.models.ts
 const vr_migrations_1 = require("vr-migrations");
-exports.DEVICE_STATUS = ["locked", "unlocked", "disabled"];
-exports.DEDICATED_USER = ["RIDER", "PASSENGER", "N/A"];
 class Device extends vr_migrations_1.Model {
     // Static initialization method
     static initialize(sequelize) {
@@ -23,6 +21,10 @@ class Device extends vr_migrations_1.Model {
                 type: vr_migrations_1.DataTypes.UUID,
                 allowNull: false,
             },
+            devicePaymentPlanId: {
+                type: vr_migrations_1.DataTypes.UUID,
+                allowNull: true,
+            },
             status: {
                 type: vr_migrations_1.DataTypes.ENUM("locked", "unlocked", "disabled"),
                 allowNull: false,
@@ -66,10 +68,10 @@ class Device extends vr_migrations_1.Model {
             onDelete: "RESTRICT",
             onUpdate: "CASCADE",
         });
-        this.hasMany(models.DevicePaymentPlan, {
-            foreignKey: "deviceId",
-            as: "paymentPlans",
-            onDelete: "CASCADE",
+        this.belongsTo(models.DevicePaymentPlan, {
+            foreignKey: "devicePaymentPlanId",
+            as: "paymentPlan",
+            onDelete: "SET NULL",
             onUpdate: "CASCADE",
         });
     }
@@ -101,5 +103,16 @@ class Device extends vr_migrations_1.Model {
     canBeActivated() {
         return this.status !== "disabled";
     }
+    isAssigned() {
+        return !!this.devicePaymentPlanId;
+    }
+    // Helper to get payment plan
+    async getPaymentPlan() {
+        if (!this.devicePaymentPlanId)
+            return null;
+        const DevicePaymentPlan = this.constructor.sequelize.models
+            .DevicePaymentPlan;
+        return await DevicePaymentPlan.findByPk(this.devicePaymentPlanId);
+    }
 }
 exports.Device = Device;

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

@@ -1,66 +1,57 @@
 import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute, ModelStatic } from "vr-migrations";
 import type { Device } from "./device.models";
 import type { User } from "./user.models";
+import type { Installment } from "./installment.models";
 export type PaymentPlanStatus = "ACTIVE" | "COMPLETED" | "DEFAULTED" | "CANCELLED";
-export type InstallmentFrequency = "DAILY" | "WEEKLY" | "MONTHLY";
 export interface DevicePaymentPlanAttributes {
     id: string;
-    deviceId: string;
     userId: string;
     pricingSnapshot: Record<string, any>;
-    totalAmount: number;
-    downPayment: number;
-    installmentAmount: number;
-    installmentFrequency: InstallmentFrequency;
     paidAmount: number;
     outstandingAmount: number;
     lastPaymentAt: Date | null;
     nextInstallmentDueAt: Date | null;
-    gracePeriodDays: number;
-    autoLockOnMiss: boolean;
     status: PaymentPlanStatus;
     completedAt: Date | null;
     createdAt: Date;
     updatedAt: Date;
-    device?: Device;
+    devices?: Device[];
     user?: User;
+    installments?: Installment[];
 }
-export interface DevicePaymentPlanCreationAttributes extends Omit<DevicePaymentPlanAttributes, "id" | "createdAt" | "updatedAt" | "paidAmount" | "status" | "gracePeriodDays" | "autoLockOnMiss"> {
+export interface DevicePaymentPlanCreationAttributes extends Omit<DevicePaymentPlanAttributes, "id" | "createdAt" | "updatedAt" | "paidAmount" | "outstandingAmount" | "lastPaymentAt" | "nextInstallmentDueAt" | "status" | "completedAt" | "devices" | "installments"> {
     id?: string;
     paidAmount?: number;
+    outstandingAmount?: number;
     status?: PaymentPlanStatus;
-    gracePeriodDays?: number;
-    autoLockOnMiss?: boolean;
 }
 export declare class DevicePaymentPlan extends Model<InferAttributes<DevicePaymentPlan>, InferCreationAttributes<DevicePaymentPlan>> implements DevicePaymentPlanAttributes {
     id: CreationOptional<string>;
-    deviceId: string;
     userId: string;
     pricingSnapshot: Record<string, any>;
-    totalAmount: number;
-    downPayment: number;
-    installmentAmount: number;
-    installmentFrequency: InstallmentFrequency;
     paidAmount: CreationOptional<number>;
     outstandingAmount: number;
     lastPaymentAt: CreationOptional<Date | null>;
     nextInstallmentDueAt: CreationOptional<Date | null>;
-    gracePeriodDays: CreationOptional<number>;
-    autoLockOnMiss: CreationOptional<boolean>;
     status: CreationOptional<PaymentPlanStatus>;
     completedAt: CreationOptional<Date | null>;
     readonly createdAt: CreationOptional<Date>;
     readonly updatedAt: CreationOptional<Date>;
-    device?: NonAttribute<Device>;
+    devices?: NonAttribute<Device[]>;
     user?: NonAttribute<User>;
+    installments?: NonAttribute<Installment[]>;
     static initialize(sequelize: any): void;
     static associate(models: Record<string, ModelStatic<Model>>): void;
-    makePayment(amount: number): Promise<void>;
+    updateProgress(): Promise<void>;
     markAsDefaulted(): Promise<void>;
     cancel(): Promise<void>;
     calculateProgress(): number;
-    isOverdue(): boolean;
-    getDaysOverdue(): number;
-    shouldAutoLock(): boolean;
+    getOverdueStatus(): Promise<{
+        isOverdue: boolean;
+        daysOverdue: number;
+    }>;
+    shouldAutoLock(): Promise<boolean>;
+    getDevices(): Promise<any[]>;
+    getInstallments(options?: any): Promise<any[]>;
 }
 export type DevicePaymentPlanModel = typeof DevicePaymentPlan;

package/dist/models/devicePaymentPlan.models.js

@@ -12,11 +12,6 @@ class DevicePaymentPlan extends vr_migrations_1.Model {
                 defaultValue: vr_migrations_1.DataTypes.UUIDV4,
                 primaryKey: true,
             },
-            deviceId: {
-                type: vr_migrations_1.DataTypes.UUID,
-                allowNull: false,
-                unique: true,
-            },
             userId: {
                 type: vr_migrations_1.DataTypes.UUID,
                 allowNull: false,
@@ -25,23 +20,6 @@ class DevicePaymentPlan extends vr_migrations_1.Model {
                 type: vr_migrations_1.DataTypes.JSONB,
                 allowNull: false,
             },
-            totalAmount: {
-                type: vr_migrations_1.DataTypes.FLOAT,
-                allowNull: false,
-            },
-            downPayment: {
-                type: vr_migrations_1.DataTypes.FLOAT,
-                allowNull: false,
-            },
-            installmentAmount: {
-                type: vr_migrations_1.DataTypes.FLOAT,
-                allowNull: false,
-            },
-            installmentFrequency: {
-                type: vr_migrations_1.DataTypes.ENUM("DAILY", "WEEKLY", "MONTHLY"),
-                allowNull: false,
-                defaultValue: "WEEKLY",
-            },
             paidAmount: {
                 type: vr_migrations_1.DataTypes.FLOAT,
                 allowNull: false,
@@ -59,16 +37,6 @@ class DevicePaymentPlan extends vr_migrations_1.Model {
                 type: vr_migrations_1.DataTypes.DATE,
                 allowNull: true,
             },
-            gracePeriodDays: {
-                type: vr_migrations_1.DataTypes.INTEGER,
-                allowNull: false,
-                defaultValue: 2,
-            },
-            autoLockOnMiss: {
-                type: vr_migrations_1.DataTypes.BOOLEAN,
-                allowNull: false,
-                defaultValue: true,
-            },
             status: {
                 type: vr_migrations_1.DataTypes.ENUM("ACTIVE", "COMPLETED", "DEFAULTED", "CANCELLED"),
                 allowNull: false,
@@ -96,71 +64,112 @@ class DevicePaymentPlan extends vr_migrations_1.Model {
     }
     // Static association method
     static associate(models) {
-        this.belongsTo(models.Device, {
-            foreignKey: "deviceId",
-            as: "device",
-            onDelete: "CASCADE",
+        // One-to-many with Devices
+        this.hasMany(models.Device, {
+            foreignKey: "devicePaymentPlanId",
+            as: "devices",
+            onDelete: "SET NULL",
             onUpdate: "CASCADE",
         });
+        // Belongs to User
         this.belongsTo(models.User, {
             foreignKey: "userId",
             as: "user",
+            onDelete: "RESTRICT",
+            onUpdate: "CASCADE",
+        });
+        // One-to-many with Installments
+        this.hasMany(models.Installment, {
+            foreignKey: "devicePaymentPlanId",
+            as: "installments",
             onDelete: "CASCADE",
             onUpdate: "CASCADE",
         });
     }
     // Custom instance methods
-    async makePayment(amount) {
-        this.paidAmount = (this.paidAmount || 0) + amount;
-        this.outstandingAmount = Math.max(0, this.outstandingAmount - amount);
-        this.lastPaymentAt = new Date();
-        // Update next installment due date
-        if (this.installmentFrequency === "DAILY") {
-            this.nextInstallmentDueAt = new Date(Date.now() + 24 * 60 * 60 * 1000);
-        }
-        else if (this.installmentFrequency === "WEEKLY") {
-            this.nextInstallmentDueAt = new Date(Date.now() + 7 * 24 * 60 * 60 * 1000);
-        }
-        else if (this.installmentFrequency === "MONTHLY") {
-            this.nextInstallmentDueAt = new Date(Date.now() + 30 * 24 * 60 * 60 * 1000);
-        }
+    async updateProgress() {
+        // Use Sequelize's built-in methods instead of mixins
+        const Installment = this.constructor.sequelize.models.Installment;
+        const installments = await Installment.findAll({
+            where: {
+                devicePaymentPlanId: this.id,
+                status: "PAID",
+            },
+        });
+        this.paidAmount = installments.reduce((sum, inst) => sum + inst.amount, 0);
+        this.outstandingAmount = this.pricingSnapshot.totalAmount - this.paidAmount;
+        // Find next pending installment
+        const nextPending = await Installment.findOne({
+            where: {
+                devicePaymentPlanId: this.id,
+                status: "PENDING",
+            },
+            order: [["dueDate", "ASC"]],
+        });
+        this.nextInstallmentDueAt = nextPending?.dueDate || null;
         // Check if completed
         if (this.outstandingAmount <= 0) {
             this.status = "COMPLETED";
             this.completedAt = new Date();
+            // Permanently unlock all devices
+            const Device = this.constructor.sequelize.models.Device;
+            await Device.update({
+                isPermanentlyUnlocked: true,
+                status: "unlocked",
+            }, { where: { devicePaymentPlanId: this.id } });
         }
         await this.save();
     }
     async markAsDefaulted() {
         this.status = "DEFAULTED";
         await this.save();
+        // Lock all devices
+        const Device = this.constructor.sequelize.models.Device;
+        await Device.update({ status: "locked" }, { where: { devicePaymentPlanId: this.id } });
     }
     async cancel() {
         this.status = "CANCELLED";
         await this.save();
     }
     calculateProgress() {
-        return (this.paidAmount / this.totalAmount) * 100;
+        return (this.paidAmount / this.pricingSnapshot.totalAmount) * 100;
     }
-    isOverdue() {
-        if (!this.nextInstallmentDueAt || this.status !== "ACTIVE") {
-            return false;
+    async getOverdueStatus() {
+        if (this.status !== "ACTIVE" || !this.nextInstallmentDueAt) {
+            return { isOverdue: false, daysOverdue: 0 };
         }
+        const graceDays = this.pricingSnapshot.gracePeriodDays || 2;
         const overdueDate = new Date(this.nextInstallmentDueAt);
-        overdueDate.setDate(overdueDate.getDate() + this.gracePeriodDays);
-        return new Date() > overdueDate;
-    }
-    getDaysOverdue() {
-        if (!this.isOverdue() || !this.nextInstallmentDueAt) {
-            return 0;
+        overdueDate.setDate(overdueDate.getDate() + graceDays);
+        const now = new Date();
+        if (now > overdueDate) {
+            const diffTime = Math.abs(now.getTime() - overdueDate.getTime());
+            const daysOverdue = Math.ceil(diffTime / (1000 * 60 * 60 * 24));
+            return { isOverdue: true, daysOverdue };
         }
-        const overdueDate = new Date(this.nextInstallmentDueAt);
-        overdueDate.setDate(overdueDate.getDate() + this.gracePeriodDays);
-        const diffTime = Math.abs(new Date().getTime() - overdueDate.getTime());
-        return Math.ceil(diffTime / (1000 * 60 * 60 * 24));
+        return { isOverdue: false, daysOverdue: 0 };
+    }
+    async shouldAutoLock() {
+        if (!this.pricingSnapshot.autoLockOnMiss)
+            return false;
+        const { isOverdue, daysOverdue } = await this.getOverdueStatus();
+        const graceDays = this.pricingSnapshot.gracePeriodDays || 2;
+        return isOverdue && daysOverdue > graceDays;
+    }
+    // Helper to get devices (using Sequelize directly)
+    async getDevices() {
+        const Device = this.constructor.sequelize.models.Device;
+        return await Device.findAll({
+            where: { devicePaymentPlanId: this.id },
+        });
     }
-    shouldAutoLock() {
-        return this.autoLockOnMiss && this.isOverdue();
+    // Helper to get installments
+    async getInstallments(options) {
+        const Installment = this.constructor.sequelize.models.Installment;
+        return await Installment.findAll({
+            where: { devicePaymentPlanId: this.id },
+            ...options,
+        });
     }
 }
 exports.DevicePaymentPlan = DevicePaymentPlan;

package/dist/models/eventLog.models.d.ts

@@ -1,6 +1,6 @@
 import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute, ModelStatic } from "vr-migrations";
 import type { User } from "./user.models";
-export declare const EVENT_ACTIONS: readonly ["USER_READ", "USER_CREATED", "USER_UPDATED", "USER_DELETED", "USER_SUSPENDED", "USER_BANNED", "USERS_LISTED", "ADMIN_FORGOT_PASSWORD", "ADMIN_LOGGED_IN", "ADMIN_LOGGED_OUT", "PASSENGER_ACCOUNT_DEACTIVATED", "PASSENGER_ACCOUNT_DELETED", "AGENT_CREATED_RIDER", "AGENT_UPDATED_RIDER", "ADMIN_CREATED_USER", "ADMIN_UPDATED_USER", "SUPER_ADMIN_PASSWORD_CHANGED", "SUPER_ADMIN_CHANGED_USER_ACCOUNT_STATUS", "SUPER_ADMIN_UPDATED_USER", "SUPER_ADMIN_CREATED_USER", "PRODUCT_CREATED", "PRODUCT_READ", "PRODUCT_UPDATED", "PRODUCT_DELETED", "PRODUCTS_LISTED", "PRODUCTS_ACTIVATED", "PRODUCTS_DEACTIVATED", "PRODUCTS_LISTED", "PRODUCT_STOCK_SET_MANUALLY", "PRODUCT_STOCK_INCREMENTED", "PRODUCT_STOCK_DECREMENTED", "PRICING_CREATED", "PRICING_READ", "PRICING_UPDATED", "PRICING_DELETED", "DEVICE_CREATED", "DEVICES_BULK_CREATED", "DEVICE_ASSIGNED", "DEVICE_READ", "DEVICE_UPDATED", "DEVICES_LISTED", "DEVICE_LOCKED", "DEVICE_UNLOCKED", "DEVICE_DISABLED", "DEVICE_REACTIVATED", "DEVICE_DELETED_PERMANENTLY", "DEVICE_REPOSSESSED", "DEVICE_PAYMENT_PLAN_CREATED", "DEVICE_PAYMENT_PLAN_READ", "DEVICE_PAYMENT_PLAN_UPDATED", "DEVICE_PAYMENT_DEFAULT_MARKED", "PAYMENT_CREATED", "PAYMENT_READ", "PAYMENTS_LISTED", "TRANSACTION_READ", "TRANSACTIONS_LISTED", "EVENT_LOG_READ", "EVENT_LOGS_LISTED", "SECURITY_CLEARANCE_MANAGED", "DEVICE_LOCK_OVERRIDDEN"];
+export declare const EVENT_ACTIONS: readonly ["USER_READ", "USER_CREATED", "USER_UPDATED", "USER_DELETED", "USER_SUSPENDED", "USER_BANNED", "USERS_LISTED", "ADMIN_FORGOT_PASSWORD", "ADMIN_LOGGED_IN", "ADMIN_LOGGED_OUT", "PASSENGER_ACCOUNT_DEACTIVATED", "PASSENGER_ACCOUNT_DELETED", "AGENT_CREATED_RIDER", "AGENT_UPDATED_RIDER", "ADMIN_CREATED_USER", "ADMIN_UPDATED_USER", "SUPER_ADMIN_PASSWORD_CHANGED", "SUPER_ADMIN_CHANGED_USER_ACCOUNT_STATUS", "SUPER_ADMIN_UPDATED_USER", "SUPER_ADMIN_CREATED_USER", "PRODUCT_CREATED", "PRODUCT_READ", "PRODUCT_UPDATED", "PRODUCT_DELETED", "PRODUCTS_LISTED", "PRODUCTS_ACTIVATED", "PRODUCTS_DEACTIVATED", "PRODUCTS_LISTED", "PRODUCT_STOCK_SET_MANUALLY", "PRODUCT_STOCK_INCREMENTED", "PRODUCT_STOCK_DECREMENTED", "PRICING_CREATED", "PRICING_READ", "PRICING_UPDATED", "PRICING_DELETED", "DEVICE_CREATED", "DEVICES_BULK_CREATED", "DEVICE_ASSIGNED", "DEVICE_READ", "DEVICE_UPDATED", "DEVICES_LISTED", "DEVICE_LOCKED", "DEVICE_UNLOCKED", "DEVICE_DISABLED", "DEVICE_REACTIVATED", "DEVICE_DELETED_PERMANENTLY", "DEVICE_REPOSSESSED", "DEVICE_PAYMENT_PLAN_CREATED", "DEVICE_PAYMENT_PLAN_READ", "DEVICE_PAYMENT_PLAN_UPDATED", "DEVICE_PAYMENT_PLAN_MARKED_DEFAULTED", "DEVICE_PAYMENT_PLAN_SOFT_DELETED", "PAYMENT_RECORDED", "PAYMENT_READ", "PAYMENTS_LISTED", "TRANSACTION_READ", "TRANSACTIONS_LISTED", "EVENT_LOG_READ", "EVENT_LOGS_LISTED", "SECURITY_CLEARANCE_MANAGED", "DEVICE_LOCK_OVERRIDDEN"];
 export type EventAction = (typeof EVENT_ACTIONS)[number];
 export type EventActorType = "USER" | "SYSTEM" | "ADMIN";
 export interface EventLogAttributes {

package/dist/models/eventLog.models.js

@@ -54,8 +54,9 @@ exports.EVENT_ACTIONS = [
     "DEVICE_PAYMENT_PLAN_CREATED",
     "DEVICE_PAYMENT_PLAN_READ",
     "DEVICE_PAYMENT_PLAN_UPDATED",
-    "DEVICE_PAYMENT_DEFAULT_MARKED",
-    "PAYMENT_CREATED",
+    "DEVICE_PAYMENT_PLAN_MARKED_DEFAULTED",
+    "DEVICE_PAYMENT_PLAN_SOFT_DELETED",
+    "PAYMENT_RECORDED",
     "PAYMENT_READ",
     "PAYMENTS_LISTED",
     "TRANSACTION_READ",

package/dist/models/index.d.ts

@@ -8,4 +8,5 @@ export * from "./pricing.models";
 export * from "./product.models";
 export * from "./securityClearance.models";
 export * from "./transaction.models";
-export type { UserModel, TransactionModel, SecurityClearanceModel, ProductModel, PricingModel, PaymentModel, IdempotencyRecordModel, EventLogModel, DevicePaymentPlanModel, DeviceModel, } from "./types";
+export * from "./installment.models";
+export type { UserModel, TransactionModel, SecurityClearanceModel, ProductModel, PricingModel, PaymentModel, IdempotencyRecordModel, EventLogModel, DevicePaymentPlanModel, DeviceModel, InstallmentModel, } from "./types";

package/dist/models/index.js

@@ -24,3 +24,4 @@ __exportStar(require("./pricing.models"), exports);
 __exportStar(require("./product.models"), exports);
 __exportStar(require("./securityClearance.models"), exports);
 __exportStar(require("./transaction.models"), exports);
+__exportStar(require("./installment.models"), exports);

package/dist/models/installment.models.d.ts

@@ -0,0 +1,59 @@
+import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute, ModelStatic } from "vr-migrations";
+import type { DevicePaymentPlan } from "./devicePaymentPlan.models";
+import type { Payment } from "./payment.models";
+export type InstallmentStatus = "PENDING" | "PAID" | "OVERDUE" | "SKIPPED";
+export interface InstallmentAttributes {
+    id: string;
+    devicePaymentPlanId: string;
+    installmentNumber: number;
+    amount: number;
+    dueDate: Date;
+    paidAt: Date | null;
+    paidAmount: number | null;
+    status: InstallmentStatus;
+    paymentId: string | null;
+    isAutoGenerated: boolean;
+    metadata: Record<string, any>;
+    createdAt: Date;
+    updatedAt: Date;
+    paymentPlan?: DevicePaymentPlan;
+    payment?: Payment;
+}
+export interface InstallmentCreationAttributes extends Omit<InstallmentAttributes, "id" | "createdAt" | "updatedAt" | "paidAt" | "paidAmount" | "status" | "paymentId" | "metadata"> {
+    id?: string;
+    paidAt?: Date | null;
+    paidAmount?: number | null;
+    status?: InstallmentStatus;
+    paymentId?: string | null;
+    metadata?: Record<string, any>;
+}
+export declare class Installment extends Model<InferAttributes<Installment>, InferCreationAttributes<Installment>> implements InstallmentAttributes {
+    id: CreationOptional<string>;
+    devicePaymentPlanId: string;
+    installmentNumber: number;
+    amount: number;
+    dueDate: Date;
+    paidAt: CreationOptional<Date | null>;
+    paidAmount: CreationOptional<number | null>;
+    status: CreationOptional<InstallmentStatus>;
+    paymentId: CreationOptional<string | null>;
+    isAutoGenerated: boolean;
+    metadata: CreationOptional<Record<string, any>>;
+    readonly createdAt: CreationOptional<Date>;
+    readonly updatedAt: CreationOptional<Date>;
+    paymentPlan?: NonAttribute<DevicePaymentPlan>;
+    payment?: NonAttribute<Payment>;
+    static initialize(sequelize: any): void;
+    static associate(models: Record<string, ModelStatic<Model>>): void;
+    markAsPaid(paymentId: string, paidAmount?: number): Promise<void>;
+    markAsOverdue(): Promise<void>;
+    skip(): Promise<void>;
+    isPaid(): boolean;
+    isOverdue(): boolean;
+    isPending(): boolean;
+    daysUntilDue(): number;
+    daysOverdue(): number;
+    static getOverdueInstallments(): Promise<Installment[]>;
+    static getPendingForPlan(planId: string): Promise<Installment[]>;
+}
+export type InstallmentModel = typeof Installment;

package/dist/models/installment.models.js

@@ -0,0 +1,181 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Installment = void 0;
+// src/models/installment.models.ts
+const vr_migrations_1 = require("vr-migrations");
+class Installment extends vr_migrations_1.Model {
+    // Static initialization method
+    static initialize(sequelize) {
+        this.init({
+            id: {
+                type: vr_migrations_1.DataTypes.UUID,
+                defaultValue: vr_migrations_1.DataTypes.UUIDV4,
+                primaryKey: true,
+            },
+            devicePaymentPlanId: {
+                type: vr_migrations_1.DataTypes.UUID,
+                allowNull: false,
+            },
+            installmentNumber: {
+                type: vr_migrations_1.DataTypes.INTEGER,
+                allowNull: false,
+            },
+            amount: {
+                type: vr_migrations_1.DataTypes.DECIMAL(10, 2),
+                allowNull: false,
+                validate: { min: 0 },
+            },
+            dueDate: {
+                type: vr_migrations_1.DataTypes.DATE,
+                allowNull: false,
+            },
+            paidAt: {
+                type: vr_migrations_1.DataTypes.DATE,
+                allowNull: true,
+            },
+            paidAmount: {
+                type: vr_migrations_1.DataTypes.DECIMAL(10, 2),
+                allowNull: true,
+                validate: { min: 0 },
+            },
+            status: {
+                type: vr_migrations_1.DataTypes.ENUM("PENDING", "PAID", "OVERDUE", "SKIPPED"),
+                allowNull: false,
+                defaultValue: "PENDING",
+            },
+            paymentId: {
+                type: vr_migrations_1.DataTypes.UUID,
+                allowNull: true,
+            },
+            isAutoGenerated: {
+                type: vr_migrations_1.DataTypes.BOOLEAN,
+                allowNull: false,
+                defaultValue: true,
+            },
+            metadata: {
+                type: vr_migrations_1.DataTypes.JSONB,
+                allowNull: false,
+                defaultValue: {},
+            },
+            createdAt: {
+                type: vr_migrations_1.DataTypes.DATE,
+                defaultValue: vr_migrations_1.DataTypes.NOW,
+            },
+            updatedAt: {
+                type: vr_migrations_1.DataTypes.DATE,
+                defaultValue: vr_migrations_1.DataTypes.NOW,
+            },
+        }, {
+            sequelize,
+            modelName: "Installment",
+            tableName: "installments",
+            timestamps: true,
+            freezeTableName: true,
+            indexes: [
+                {
+                    unique: true,
+                    fields: ["devicePaymentPlanId", "installmentNumber"],
+                    name: "unique_installment_number_per_plan",
+                },
+                {
+                    fields: ["status"],
+                    name: "installment_status_idx",
+                },
+                {
+                    fields: ["dueDate"],
+                    name: "installment_due_date_idx",
+                },
+            ],
+            validate: {
+                paidAmountMatchesAmount() {
+                    if (this.status === "PAID" && this.paidAmount !== this.amount) {
+                        throw new Error("Paid amount must equal installment amount when status is PAID");
+                    }
+                },
+            },
+        });
+    }
+    // Static association method
+    static associate(models) {
+        this.belongsTo(models.DevicePaymentPlan, {
+            foreignKey: "devicePaymentPlanId",
+            as: "paymentPlan",
+            onDelete: "CASCADE",
+            onUpdate: "CASCADE",
+        });
+        this.belongsTo(models.Payment, {
+            foreignKey: "paymentId",
+            as: "payment",
+            onDelete: "SET NULL",
+            onUpdate: "CASCADE",
+        });
+    }
+    // Custom instance methods
+    async markAsPaid(paymentId, paidAmount) {
+        this.status = "PAID";
+        this.paidAt = new Date();
+        this.paidAmount = paidAmount || this.amount;
+        this.paymentId = paymentId;
+        await this.save();
+        // Update the parent plan's progress
+        const DevicePaymentPlan = this.constructor.sequelize.models
+            .DevicePaymentPlan;
+        const plan = await DevicePaymentPlan.findByPk(this.devicePaymentPlanId);
+        if (plan) {
+            await plan.updateProgress();
+        }
+    }
+    async markAsOverdue() {
+        if (this.status === "PENDING" && new Date() > this.dueDate) {
+            this.status = "OVERDUE";
+            await this.save();
+        }
+    }
+    async skip() {
+        this.status = "SKIPPED";
+        await this.save();
+    }
+    isPaid() {
+        return this.status === "PAID";
+    }
+    isOverdue() {
+        return this.status === "OVERDUE";
+    }
+    isPending() {
+        return this.status === "PENDING";
+    }
+    daysUntilDue() {
+        const today = new Date();
+        const diffTime = this.dueDate.getTime() - today.getTime();
+        return Math.ceil(diffTime / (1000 * 60 * 60 * 24));
+    }
+    daysOverdue() {
+        if (!this.isOverdue() &&
+            !(this.status === "PENDING" && new Date() > this.dueDate)) {
+            return 0;
+        }
+        const today = new Date();
+        const diffTime = today.getTime() - this.dueDate.getTime();
+        return Math.ceil(diffTime / (1000 * 60 * 60 * 24));
+    }
+    // Static methods
+    static async getOverdueInstallments() {
+        return await this.findAll({
+            where: {
+                status: "PENDING",
+                dueDate: { [vr_migrations_1.Op.lt]: new Date() },
+            },
+            include: ["paymentPlan"],
+        });
+    }
+    static async getPendingForPlan(planId) {
+        return await this.findAll({
+            where: {
+                devicePaymentPlanId: planId,
+                status: "PENDING",
+            },
+            order: [["dueDate", "ASC"]],
+        });
+    }
+}
+exports.Installment = Installment;

package/dist/models/pricing.models.d.ts

@@ -1,33 +1,43 @@
 import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute, ModelStatic } from "vr-migrations";
 import type { Product } from "./product.models";
+export type PricingType = "HIRE_PURCHASE" | "FULL_PAYMENT";
+export type InstallmentFrequency = "DAILY" | "WEEKLY" | "MONTHLY";
 export interface PricingAttributes {
     id: string;
     productId: string;
     name: string;
-    upfrontPrice: number;
+    type: PricingType;
+    totalAmount: number;
     downPayment: number;
     installmentAmount: number | null;
-    installmentIntervalDays: number | null;
-    totalAmount: number;
+    installmentFrequency: InstallmentFrequency | null;
+    installmentCount: number | null;
+    gracePeriodDays: number;
+    autoLockOnMiss: boolean;
     isActive: boolean;
     createdAt: Date;
     updatedAt: Date;
     product?: Product;
 }
-export interface PricingCreationAttributes extends Omit<PricingAttributes, "id" | "createdAt" | "updatedAt" | "isActive" | "downPayment"> {
+export interface PricingCreationAttributes extends Omit<PricingAttributes, "id" | "createdAt" | "updatedAt" | "isActive" | "downPayment" | "gracePeriodDays" | "autoLockOnMiss"> {
     id?: string;
     isActive?: boolean;
     downPayment?: number;
+    gracePeriodDays?: number;
+    autoLockOnMiss?: boolean;
 }
 export declare class Pricing extends Model<InferAttributes<Pricing>, InferCreationAttributes<Pricing>> implements PricingAttributes {
     id: CreationOptional<string>;
     productId: string;
     name: string;
-    upfrontPrice: number;
+    type: PricingType;
+    totalAmount: number;
     downPayment: CreationOptional<number>;
     installmentAmount: CreationOptional<number | null>;
-    installmentIntervalDays: CreationOptional<number | null>;
-    totalAmount: number;
+    installmentFrequency: CreationOptional<InstallmentFrequency | null>;
+    installmentCount: CreationOptional<number | null>;
+    gracePeriodDays: CreationOptional<number>;
+    autoLockOnMiss: CreationOptional<boolean>;
     isActive: CreationOptional<boolean>;
     readonly createdAt: CreationOptional<Date>;
     readonly updatedAt: CreationOptional<Date>;
@@ -39,5 +49,6 @@ export declare class Pricing extends Model<InferAttributes<Pricing>, InferCreati
     isInstallmentPlan(): boolean;
     getInstallmentCount(): number | null;
     calculateRemainingAmount(paidAmount: number): number;
+    calculateNextDueDate(fromDate?: Date): Date | null;
 }
 export type PricingModel = typeof Pricing;

package/dist/models/pricing.models.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Pricing = void 0;
+// src/models/pricing.models.ts
 const vr_migrations_1 = require("vr-migrations");
 class Pricing extends vr_migrations_1.Model {
     // Static initialization method
@@ -13,15 +14,42 @@ class Pricing extends vr_migrations_1.Model {
             },
             productId: { type: vr_migrations_1.DataTypes.UUID, allowNull: false },
             name: { type: vr_migrations_1.DataTypes.STRING(100), allowNull: false },
-            upfrontPrice: { type: vr_migrations_1.DataTypes.DECIMAL(10, 2), allowNull: false },
+            type: {
+                type: vr_migrations_1.DataTypes.ENUM("HIRE_PURCHASE", "FULL_PAYMENT"),
+                allowNull: false,
+            },
+            totalAmount: {
+                type: vr_migrations_1.DataTypes.DECIMAL(10, 2),
+                allowNull: false,
+                field: "total_amount", // Maps to database column
+            },
             downPayment: {
                 type: vr_migrations_1.DataTypes.DECIMAL(10, 2),
                 allowNull: false,
                 defaultValue: 0,
             },
-            installmentAmount: { type: vr_migrations_1.DataTypes.DECIMAL(10, 2), allowNull: true },
-            installmentIntervalDays: { type: vr_migrations_1.DataTypes.INTEGER, allowNull: true },
-            totalAmount: { type: vr_migrations_1.DataTypes.DECIMAL(10, 2), allowNull: false },
+            installmentAmount: {
+                type: vr_migrations_1.DataTypes.DECIMAL(10, 2),
+                allowNull: true,
+            },
+            installmentFrequency: {
+                type: vr_migrations_1.DataTypes.ENUM("DAILY", "WEEKLY", "MONTHLY"),
+                allowNull: true,
+            },
+            installmentCount: {
+                type: vr_migrations_1.DataTypes.INTEGER,
+                allowNull: true,
+            },
+            gracePeriodDays: {
+                type: vr_migrations_1.DataTypes.INTEGER,
+                allowNull: false,
+                defaultValue: 2,
+            },
+            autoLockOnMiss: {
+                type: vr_migrations_1.DataTypes.BOOLEAN,
+                allowNull: false,
+                defaultValue: true,
+            },
             isActive: {
                 type: vr_migrations_1.DataTypes.BOOLEAN,
                 allowNull: false,
@@ -55,16 +83,33 @@ class Pricing extends vr_migrations_1.Model {
         await this.save();
     }
     isInstallmentPlan() {
-        return !!(this.installmentAmount && this.installmentIntervalDays);
+        return this.type === "HIRE_PURCHASE";
     }
     getInstallmentCount() {
         if (!this.isInstallmentPlan())
             return null;
-        const remainingAmount = this.totalAmount - this.downPayment;
-        return Math.ceil(remainingAmount / (this.installmentAmount || 1));
+        return this.installmentCount;
     }
     calculateRemainingAmount(paidAmount) {
         return Math.max(0, this.totalAmount - paidAmount);
     }
+    // Helper to calculate next due date based on frequency
+    calculateNextDueDate(fromDate = new Date()) {
+        if (!this.installmentFrequency)
+            return null;
+        const nextDate = new Date(fromDate);
+        switch (this.installmentFrequency) {
+            case "DAILY":
+                nextDate.setDate(nextDate.getDate() + 1);
+                break;
+            case "WEEKLY":
+                nextDate.setDate(nextDate.getDate() + 7);
+                break;
+            case "MONTHLY":
+                nextDate.setMonth(nextDate.getMonth() + 1);
+                break;
+        }
+        return nextDate;
+    }
 }
 exports.Pricing = Pricing;

package/dist/models/types.d.ts

@@ -8,3 +8,4 @@ export type { IdempotencyRecordModel } from "./idempotencyRecord.models";
 export type { EventLogModel } from "./eventLog.models";
 export type { DevicePaymentPlanModel } from "./devicePaymentPlan.models";
 export type { DeviceModel } from "./device.models";
+export type { InstallmentModel } from "./installment.models";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vr-models",
-  "version": "1.0.15",
+  "version": "1.0.17",
   "description": "Shared database models package for VR applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",