vr-models 1.0.1

package/README.md

@@ -0,0 +1 @@
+

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./models";

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./models"), exports);

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

@@ -0,0 +1,18 @@
+import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute } from "vr-migrations";
+import type { Product } from "./product.models";
+import type { DevicePaymentPlan } from "./devicePaymentPlan.models";
+export type DeviceStatus = "locked" | "unlocked" | "disabled";
+export declare class Device extends Model<InferAttributes<Device>, InferCreationAttributes<Device>> {
+    id: CreationOptional<string>;
+    serialNumber: string;
+    productId: string;
+    status: CreationOptional<DeviceStatus>;
+    isPermanentlyUnlocked: CreationOptional<boolean>;
+    activatedAt: CreationOptional<Date | null>;
+    readonly createdAt: CreationOptional<Date>;
+    readonly updatedAt: CreationOptional<Date>;
+    product?: NonAttribute<Product>;
+    paymentPlans?: NonAttribute<DevicePaymentPlan[]>;
+}
+export declare const initDeviceModel: (sequelize: any) => void;
+export type DeviceModel = typeof Device;

package/dist/models/device.models.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initDeviceModel = exports.Device = void 0;
+// src/models/device.models.ts
+const vr_migrations_1 = require("vr-migrations");
+class Device extends vr_migrations_1.Model {
+}
+exports.Device = Device;
+const initDeviceModel = (sequelize) => {
+    Device.init({
+        id: {
+            type: vr_migrations_1.DataTypes.UUID,
+            defaultValue: vr_migrations_1.DataTypes.UUIDV4,
+            primaryKey: true,
+        },
+        serialNumber: {
+            type: vr_migrations_1.DataTypes.STRING(64),
+            allowNull: false,
+            unique: true,
+        },
+        productId: {
+            type: vr_migrations_1.DataTypes.UUID,
+            allowNull: false,
+        },
+        status: {
+            type: vr_migrations_1.DataTypes.ENUM("locked", "unlocked", "disabled"),
+            allowNull: false,
+            defaultValue: "locked",
+        },
+        isPermanentlyUnlocked: {
+            type: vr_migrations_1.DataTypes.BOOLEAN,
+            allowNull: false,
+            defaultValue: false,
+        },
+        activatedAt: {
+            type: vr_migrations_1.DataTypes.DATE,
+            allowNull: true,
+        },
+        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: "Device",
+        tableName: "devices",
+        timestamps: true,
+        freezeTableName: true,
+    });
+};
+exports.initDeviceModel = initDeviceModel;

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

@@ -0,0 +1,29 @@
+import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute } from "vr-migrations";
+import type { Device } from "./device.models";
+import type { User } from "./user.models";
+export type PaymentPlanStatus = "ACTIVE" | "COMPLETED" | "DEFAULTED" | "CANCELLED";
+export type InstallmentFrequency = "daily" | "weekly" | "monthly";
+export declare class DevicePaymentPlan extends Model<InferAttributes<DevicePaymentPlan>, InferCreationAttributes<DevicePaymentPlan>> {
+    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>;
+    user?: NonAttribute<User>;
+}
+export declare const initDevicePaymentPlanModel: (sequelize: any) => void;
+export type DevicePaymentPlanModel = typeof DevicePaymentPlan;

package/dist/models/devicePaymentPlan.models.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initDevicePaymentPlanModel = exports.DevicePaymentPlan = void 0;
+// src/models/devicePaymentPlan.models.ts
+const vr_migrations_1 = require("vr-migrations");
+class DevicePaymentPlan extends vr_migrations_1.Model {
+}
+exports.DevicePaymentPlan = DevicePaymentPlan;
+const initDevicePaymentPlanModel = (sequelize) => {
+    DevicePaymentPlan.init({
+        id: {
+            type: vr_migrations_1.DataTypes.UUID,
+            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,
+        },
+        pricingSnapshot: {
+            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,
+            defaultValue: 0,
+        },
+        outstandingAmount: {
+            type: vr_migrations_1.DataTypes.FLOAT,
+            allowNull: false,
+        },
+        lastPaymentAt: {
+            type: vr_migrations_1.DataTypes.DATE,
+            allowNull: true,
+        },
+        nextInstallmentDueAt: {
+            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,
+            defaultValue: "ACTIVE",
+        },
+        completedAt: {
+            type: vr_migrations_1.DataTypes.DATE,
+            allowNull: true,
+        },
+        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: "DevicePaymentPlan",
+        tableName: "device_payment_plans",
+        timestamps: true,
+        freezeTableName: true,
+    });
+};
+exports.initDevicePaymentPlanModel = initDevicePaymentPlanModel;

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

@@ -0,0 +1,18 @@
+import { Model, InferAttributes, InferCreationAttributes, CreationOptional } from "vr-migrations";
+export declare const EVENT_ACTIONS: readonly ["USER_READ", "USER_UPDATED", "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", "DEVICE_ASSIGNED", "DEVICE_READ", "DEVICE_UPDATED", "DEVICES_LISTED", "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 type EventAction = (typeof EVENT_ACTIONS)[number];
+export type EventActorType = "USER" | "SYSTEM";
+export declare class EventLog extends Model<InferAttributes<EventLog>, InferCreationAttributes<EventLog>> {
+    id: CreationOptional<string>;
+    actorType?: EventActorType;
+    actorId: CreationOptional<string | null>;
+    action: EventAction;
+    entity: string;
+    entityId?: CreationOptional<string | null>;
+    metadata?: CreationOptional<Record<string, any>>;
+    ipAddress?: CreationOptional<string | null>;
+    userAgent?: CreationOptional<string | null>;
+    readonly createdAt: CreationOptional<Date>;
+    static initialize(sequelize: any): void;
+}
+export type EventLogModel = typeof EventLog;

package/dist/models/eventLog.models.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventLog = exports.EVENT_ACTIONS = void 0;
+const vr_migrations_1 = require("vr-migrations");
+exports.EVENT_ACTIONS = [
+    "USER_READ",
+    "USER_UPDATED",
+    "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",
+    "DEVICE_ASSIGNED",
+    "DEVICE_READ",
+    "DEVICE_UPDATED",
+    "DEVICES_LISTED",
+    "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",
+];
+class EventLog extends vr_migrations_1.Model {
+    static initialize(sequelize) {
+        this.init({
+            id: {
+                type: vr_migrations_1.DataTypes.UUID,
+                defaultValue: vr_migrations_1.DataTypes.UUIDV4,
+                primaryKey: true,
+            },
+            actorType: {
+                type: vr_migrations_1.DataTypes.ENUM("USER", "SYSTEM"),
+                allowNull: false,
+            },
+            actorId: {
+                type: vr_migrations_1.DataTypes.UUID,
+                allowNull: true,
+            },
+            action: {
+                type: vr_migrations_1.DataTypes.STRING(100),
+                allowNull: false,
+            },
+            entity: {
+                type: vr_migrations_1.DataTypes.STRING(100),
+                allowNull: false,
+            },
+            entityId: {
+                type: vr_migrations_1.DataTypes.UUID,
+                allowNull: true,
+            },
+            metadata: {
+                type: vr_migrations_1.DataTypes.JSONB,
+                allowNull: false,
+                defaultValue: {},
+            },
+            ipAddress: {
+                type: vr_migrations_1.DataTypes.STRING(45),
+                allowNull: true,
+            },
+            userAgent: {
+                type: vr_migrations_1.DataTypes.TEXT,
+                allowNull: true,
+            },
+            createdAt: {
+                type: vr_migrations_1.DataTypes.DATE,
+                defaultValue: vr_migrations_1.DataTypes.NOW,
+            },
+        }, {
+            sequelize,
+            tableName: "event_logs",
+            modelName: "EventLog",
+            timestamps: true,
+            updatedAt: false,
+        });
+    }
+}
+exports.EventLog = EventLog;

package/dist/models/idempotencyRecord.models.d.ts

@@ -0,0 +1,14 @@
+import { Model, InferAttributes, InferCreationAttributes, CreationOptional } from "vr-migrations";
+export declare class IdempotencyRecord extends Model<InferAttributes<IdempotencyRecord>, InferCreationAttributes<IdempotencyRecord>> {
+    id: CreationOptional<string>;
+    key: string;
+    requestMethod: string;
+    requestPath: string;
+    requestParams: CreationOptional<Record<string, any> | null>;
+    responseStatusCode: CreationOptional<number | null>;
+    responseBody: CreationOptional<Record<string, any>>;
+    readonly createdAt: CreationOptional<Date>;
+    expiresAt: Date;
+    static initialize(sequelize: any): void;
+}
+export type IdempotencyRecordModel = typeof IdempotencyRecord;

package/dist/models/idempotencyRecord.models.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdempotencyRecord = void 0;
+const vr_migrations_1 = require("vr-migrations");
+class IdempotencyRecord extends vr_migrations_1.Model {
+    static initialize(sequelize) {
+        this.init({
+            id: {
+                type: vr_migrations_1.DataTypes.UUID,
+                defaultValue: vr_migrations_1.DataTypes.UUIDV4,
+                primaryKey: true,
+            },
+            key: {
+                type: vr_migrations_1.DataTypes.STRING(128),
+                allowNull: false,
+                unique: true,
+            },
+            requestMethod: {
+                type: vr_migrations_1.DataTypes.STRING(10),
+                allowNull: false,
+            },
+            requestPath: {
+                type: vr_migrations_1.DataTypes.STRING(255),
+                allowNull: false,
+            },
+            requestParams: {
+                type: vr_migrations_1.DataTypes.JSONB,
+                allowNull: true,
+            },
+            responseStatusCode: {
+                type: vr_migrations_1.DataTypes.INTEGER,
+                allowNull: true,
+            },
+            responseBody: {
+                type: vr_migrations_1.DataTypes.JSONB,
+                allowNull: true,
+            },
+            createdAt: {
+                type: vr_migrations_1.DataTypes.DATE,
+                defaultValue: vr_migrations_1.DataTypes.NOW,
+            },
+            expiresAt: {
+                type: vr_migrations_1.DataTypes.DATE,
+                allowNull: false,
+            },
+        }, {
+            sequelize,
+            tableName: "idempotency_records",
+            modelName: "IdempotencyRecord",
+            timestamps: true,
+            updatedAt: false,
+            hooks: {
+                beforeCreate(record) {
+                    const expiresAt = new Date();
+                    expiresAt.setHours(expiresAt.getHours() + 24);
+                    record.expiresAt = expiresAt;
+                },
+            },
+        });
+    }
+}
+exports.IdempotencyRecord = IdempotencyRecord;

package/dist/models/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./user.models";
+export * from "./device.models";
+export * from "./devicePaymentPlan.models";
+export * from "./eventLog.models";
+export * from "./idempotencyRecord.models";
+export * from "./payment.models";
+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";

package/dist/models/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./user.models"), exports);
+__exportStar(require("./device.models"), exports);
+__exportStar(require("./devicePaymentPlan.models"), exports);
+__exportStar(require("./eventLog.models"), exports);
+__exportStar(require("./idempotencyRecord.models"), exports);
+__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);

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

@@ -0,0 +1,24 @@
+import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute, ModelStatic } from "vr-migrations";
+export type PaymentProvider = "mtn_momo" | "airtel_money";
+export type PaymentStatus = "pending" | "succeeded" | "failed";
+export declare class Payment extends Model<InferAttributes<Payment>, InferCreationAttributes<Payment>> {
+    id: CreationOptional<string>;
+    userId: string;
+    devicePaymentPlanId: string;
+    transactionId: CreationOptional<string | null>;
+    idempotencyKeyId: CreationOptional<string | null>;
+    amount: number;
+    provider: PaymentProvider;
+    providerReference: CreationOptional<string | null>;
+    status: PaymentStatus;
+    metadata: Record<string, any>;
+    readonly createdAt: CreationOptional<Date>;
+    readonly updatedAt: CreationOptional<Date>;
+    user?: NonAttribute<any>;
+    devicePaymentPlan?: NonAttribute<any>;
+    transaction?: NonAttribute<any>;
+    idempotencyKey?: NonAttribute<any>;
+    static initialize(sequelize: any): void;
+    static associate(models: Record<string, ModelStatic<Model>>): void;
+}
+export type PaymentModel = typeof Payment;

package/dist/models/payment.models.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Payment = void 0;
+const vr_migrations_1 = require("vr-migrations");
+class Payment extends vr_migrations_1.Model {
+    static initialize(sequelize) {
+        this.init({
+            id: {
+                type: vr_migrations_1.DataTypes.UUID,
+                defaultValue: vr_migrations_1.DataTypes.UUIDV4,
+                primaryKey: true,
+            },
+            userId: { type: vr_migrations_1.DataTypes.UUID, allowNull: false },
+            devicePaymentPlanId: { type: vr_migrations_1.DataTypes.UUID, allowNull: false },
+            transactionId: { type: vr_migrations_1.DataTypes.UUID, allowNull: true },
+            idempotencyKeyId: { type: vr_migrations_1.DataTypes.UUID, allowNull: true },
+            amount: {
+                type: vr_migrations_1.DataTypes.FLOAT,
+                allowNull: false,
+                validate: { min: 1 },
+            },
+            provider: {
+                type: vr_migrations_1.DataTypes.ENUM("mtn_momo", "airtel_money"),
+                allowNull: false,
+            },
+            providerReference: { type: vr_migrations_1.DataTypes.STRING, allowNull: true },
+            status: {
+                type: vr_migrations_1.DataTypes.ENUM("pending", "succeeded", "failed"),
+                allowNull: false,
+                defaultValue: "pending",
+            },
+            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,
+            tableName: "payments",
+            modelName: "Payment",
+            hooks: {
+                beforeUpdate: (payment) => {
+                    if (payment.status === "succeeded" && !payment.providerReference) {
+                        throw new Error("providerReference is required for successful payments");
+                    }
+                },
+            },
+        });
+    }
+    static associate(models) {
+        this.belongsTo(models.User, { foreignKey: "userId", as: "user" });
+        this.belongsTo(models.DevicePaymentPlan, {
+            foreignKey: "devicePaymentPlanId",
+            as: "devicePaymentPlan",
+        });
+        this.belongsTo(models.Transaction, {
+            foreignKey: "transactionId",
+            as: "transaction",
+        });
+        this.belongsTo(models.IdempotencyRecord, {
+            foreignKey: "idempotencyKeyId",
+            as: "idempotencyKey",
+        });
+    }
+}
+exports.Payment = Payment;

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

@@ -0,0 +1,18 @@
+import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute, ModelStatic } from "vr-migrations";
+export declare class Pricing extends Model<InferAttributes<Pricing>, InferCreationAttributes<Pricing>> {
+    id: CreationOptional<string>;
+    productId: string;
+    name: string;
+    upfrontPrice: number;
+    downPayment: number;
+    installmentAmount?: number;
+    installmentIntervalDays?: number;
+    totalAmount: number;
+    isActive: CreationOptional<boolean>;
+    readonly createdAt: CreationOptional<Date>;
+    readonly updatedAt: CreationOptional<Date>;
+    product?: NonAttribute<any>;
+    static initialize(sequelize: any): void;
+    static associate(models: Record<string, ModelStatic<Model>>): void;
+}
+export type PricingModel = typeof Pricing;

package/dist/models/pricing.models.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Pricing = void 0;
+const vr_migrations_1 = require("vr-migrations");
+class Pricing extends vr_migrations_1.Model {
+    static initialize(sequelize) {
+        this.init({
+            id: {
+                type: vr_migrations_1.DataTypes.UUID,
+                defaultValue: vr_migrations_1.DataTypes.UUIDV4,
+                primaryKey: true,
+            },
+            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 },
+            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 },
+            isActive: {
+                type: vr_migrations_1.DataTypes.BOOLEAN,
+                allowNull: false,
+                defaultValue: true,
+            },
+            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,
+            tableName: "pricings",
+            modelName: "Pricing",
+            timestamps: true,
+        });
+    }
+    static associate(models) {
+        this.belongsTo(models.Product, { foreignKey: "productId", as: "product" });
+    }
+}
+exports.Pricing = Pricing;

package/dist/models/product.models.d.ts

@@ -0,0 +1,15 @@
+import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute, ModelStatic } from "vr-migrations";
+export declare class Product extends Model<InferAttributes<Product>, InferCreationAttributes<Product>> {
+    id: CreationOptional<string>;
+    name: string;
+    description: string;
+    stock: CreationOptional<number>;
+    isActive: CreationOptional<boolean>;
+    readonly createdAt: CreationOptional<Date>;
+    readonly updatedAt: CreationOptional<Date>;
+    pricings?: NonAttribute<any[]>;
+    devices?: NonAttribute<any[]>;
+    static initialize(sequelize: any): void;
+    static associate(models: Record<string, ModelStatic<Model>>): void;
+}
+export type ProductModel = typeof Product;

package/dist/models/product.models.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Product = void 0;
+const vr_migrations_1 = require("vr-migrations");
+class Product extends vr_migrations_1.Model {
+    static initialize(sequelize) {
+        this.init({
+            id: {
+                type: vr_migrations_1.DataTypes.UUID,
+                defaultValue: vr_migrations_1.DataTypes.UUIDV4,
+                primaryKey: true,
+            },
+            name: { type: vr_migrations_1.DataTypes.STRING(150), allowNull: false },
+            description: { type: vr_migrations_1.DataTypes.TEXT, allowNull: true },
+            stock: { type: vr_migrations_1.DataTypes.INTEGER, allowNull: false, defaultValue: 0 },
+            isActive: {
+                type: vr_migrations_1.DataTypes.BOOLEAN,
+                allowNull: false,
+                defaultValue: true,
+            },
+            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,
+            tableName: "products",
+            modelName: "Product",
+            timestamps: true,
+        });
+    }
+    static associate(models) {
+        this.hasMany(models.Pricing, { foreignKey: "productId", as: "pricings" });
+        this.hasMany(models.Device, { foreignKey: "productId", as: "devices" });
+    }
+}
+exports.Product = Product;

package/dist/models/securityClearance.models.d.ts

@@ -0,0 +1,46 @@
+import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute } from "vr-migrations";
+import type { User } from "./user.models";
+export declare const USER_ROLES: readonly ["RIDER", "PASSENGER", "ADMIN", "AGENT", "SUPER_ADMIN"];
+export type UserRole = (typeof USER_ROLES)[number];
+export declare enum Permission {
+    READ_USER = "READ_USER",
+    UPDATE_USER = "UPDATE_USER",
+    LIST_USERS = "LIST_USERS",
+    CREATE_PRODUCT = "CREATE_PRODUCT",
+    READ_PRODUCT = "READ_PRODUCT",
+    UPDATE_PRODUCT = "UPDATE_PRODUCT",
+    DELETE_PRODUCT = "DELETE_PRODUCT",
+    LIST_PRODUCTS = "LIST_PRODUCTS",
+    ASSIGN_DEVICE = "ASSIGN_DEVICE",
+    READ_DEVICE = "READ_DEVICE",
+    UPDATE_DEVICE = "UPDATE_DEVICE",
+    LIST_DEVICES = "LIST_DEVICES",
+    REPOSSESS_DEVICE = "REPOSSESS_DEVICE",
+    CREATE_DEVICE_PAYMENT_PLAN = "CREATE_DEVICE_PAYMENT_PLAN",
+    READ_DEVICE_PAYMENT_PLAN = "READ_DEVICE_PAYMENT_PLAN",
+    UPDATE_DEVICE_PAYMENT_PLAN = "UPDATE_DEVICE_PAYMENT_PLAN",
+    MARK_PAYMENT_DEFAULT = "MARK_PAYMENT_DEFAULT",
+    CREATE_PAYMENT = "CREATE_PAYMENT",
+    READ_PAYMENT = "READ_PAYMENT",
+    LIST_PAYMENTS = "LIST_PAYMENTS",
+    READ_TRANSACTION = "READ_TRANSACTION",
+    LIST_TRANSACTIONS = "LIST_TRANSACTIONS",
+    READ_EVENT_LOG = "READ_EVENT_LOG",
+    LIST_EVENT_LOGS = "LIST_EVENT_LOGS",
+    MANAGE_SECURITY_CLEARANCE = "MANAGE_SECURITY_CLEARANCE",
+    OVERRIDE_DEVICE_LOCK = "OVERRIDE_DEVICE_LOCK"
+}
+export declare class SecurityClearance extends Model<InferAttributes<SecurityClearance>, InferCreationAttributes<SecurityClearance>> {
+    id: CreationOptional<string>;
+    role: UserRole;
+    description: CreationOptional<string | null>;
+    level: number;
+    permissions: Permission[];
+    isDefault: boolean;
+    createdAt: CreationOptional<Date>;
+    updatedAt: CreationOptional<Date>;
+    users?: NonAttribute<User[]>;
+    hasPermission(permission: Permission): boolean;
+}
+export declare const initSecurityClearanceModel: (sequelize: any) => void;
+export type SecurityClearanceModel = typeof SecurityClearance;

package/dist/models/securityClearance.models.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initSecurityClearanceModel = exports.SecurityClearance = exports.Permission = exports.USER_ROLES = void 0;
+// src/models/securityClearance.models.ts
+const vr_migrations_1 = require("vr-migrations");
+exports.USER_ROLES = [
+    "RIDER",
+    "PASSENGER",
+    "ADMIN",
+    "AGENT",
+    "SUPER_ADMIN",
+];
+var Permission;
+(function (Permission) {
+    Permission["READ_USER"] = "READ_USER";
+    Permission["UPDATE_USER"] = "UPDATE_USER";
+    Permission["LIST_USERS"] = "LIST_USERS";
+    Permission["CREATE_PRODUCT"] = "CREATE_PRODUCT";
+    Permission["READ_PRODUCT"] = "READ_PRODUCT";
+    Permission["UPDATE_PRODUCT"] = "UPDATE_PRODUCT";
+    Permission["DELETE_PRODUCT"] = "DELETE_PRODUCT";
+    Permission["LIST_PRODUCTS"] = "LIST_PRODUCTS";
+    Permission["ASSIGN_DEVICE"] = "ASSIGN_DEVICE";
+    Permission["READ_DEVICE"] = "READ_DEVICE";
+    Permission["UPDATE_DEVICE"] = "UPDATE_DEVICE";
+    Permission["LIST_DEVICES"] = "LIST_DEVICES";
+    Permission["REPOSSESS_DEVICE"] = "REPOSSESS_DEVICE";
+    Permission["CREATE_DEVICE_PAYMENT_PLAN"] = "CREATE_DEVICE_PAYMENT_PLAN";
+    Permission["READ_DEVICE_PAYMENT_PLAN"] = "READ_DEVICE_PAYMENT_PLAN";
+    Permission["UPDATE_DEVICE_PAYMENT_PLAN"] = "UPDATE_DEVICE_PAYMENT_PLAN";
+    Permission["MARK_PAYMENT_DEFAULT"] = "MARK_PAYMENT_DEFAULT";
+    Permission["CREATE_PAYMENT"] = "CREATE_PAYMENT";
+    Permission["READ_PAYMENT"] = "READ_PAYMENT";
+    Permission["LIST_PAYMENTS"] = "LIST_PAYMENTS";
+    Permission["READ_TRANSACTION"] = "READ_TRANSACTION";
+    Permission["LIST_TRANSACTIONS"] = "LIST_TRANSACTIONS";
+    Permission["READ_EVENT_LOG"] = "READ_EVENT_LOG";
+    Permission["LIST_EVENT_LOGS"] = "LIST_EVENT_LOGS";
+    Permission["MANAGE_SECURITY_CLEARANCE"] = "MANAGE_SECURITY_CLEARANCE";
+    Permission["OVERRIDE_DEVICE_LOCK"] = "OVERRIDE_DEVICE_LOCK";
+})(Permission || (exports.Permission = Permission = {}));
+class SecurityClearance extends vr_migrations_1.Model {
+    hasPermission(permission) {
+        return this.permissions.includes(permission);
+    }
+}
+exports.SecurityClearance = SecurityClearance;
+const initSecurityClearanceModel = (sequelize) => {
+    SecurityClearance.init({
+        id: {
+            type: vr_migrations_1.DataTypes.UUID,
+            defaultValue: vr_migrations_1.DataTypes.UUIDV4,
+            primaryKey: true,
+        },
+        role: {
+            type: vr_migrations_1.DataTypes.ENUM(...exports.USER_ROLES),
+            allowNull: false,
+            unique: true,
+        },
+        description: {
+            type: vr_migrations_1.DataTypes.TEXT,
+            allowNull: true,
+        },
+        level: {
+            type: vr_migrations_1.DataTypes.INTEGER,
+            allowNull: false,
+        },
+        permissions: {
+            type: vr_migrations_1.DataTypes.ARRAY(vr_migrations_1.DataTypes.STRING),
+            allowNull: false,
+            defaultValue: [],
+        },
+        isDefault: {
+            type: vr_migrations_1.DataTypes.BOOLEAN,
+            defaultValue: false,
+        },
+        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: "SecurityClearance",
+        tableName: "security_clearances",
+        timestamps: true,
+        freezeTableName: true,
+    });
+};
+exports.initSecurityClearanceModel = initSecurityClearanceModel;

package/dist/models/transaction.models.d.ts

@@ -0,0 +1,18 @@
+import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute, ModelStatic } from "vr-migrations";
+export type TransactionStatus = "succeeded" | "failed";
+export declare class Transaction extends Model<InferAttributes<Transaction>, InferCreationAttributes<Transaction>> {
+    id: CreationOptional<string>;
+    userId: string;
+    paymentId: string;
+    amount: number;
+    status: TransactionStatus;
+    providerReference: string;
+    metadata: Record<string, any>;
+    readonly createdAt: CreationOptional<Date>;
+    readonly updatedAt: CreationOptional<Date>;
+    payment?: NonAttribute<any>;
+    user?: NonAttribute<any>;
+    static initialize(sequelize: any): void;
+    static associate(models: Record<string, ModelStatic<Model>>): void;
+}
+export type TransactionModel = typeof Transaction;

package/dist/models/transaction.models.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Transaction = void 0;
+const vr_migrations_1 = require("vr-migrations");
+class Transaction extends vr_migrations_1.Model {
+    static initialize(sequelize) {
+        this.init({
+            id: {
+                type: vr_migrations_1.DataTypes.UUID,
+                defaultValue: vr_migrations_1.DataTypes.UUIDV4,
+                primaryKey: true,
+            },
+            userId: { type: vr_migrations_1.DataTypes.UUID, allowNull: false },
+            paymentId: { type: vr_migrations_1.DataTypes.UUID, allowNull: false },
+            amount: {
+                type: vr_migrations_1.DataTypes.FLOAT,
+                allowNull: false,
+                validate: { min: 1 },
+            },
+            status: {
+                type: vr_migrations_1.DataTypes.ENUM("succeeded", "failed"),
+                allowNull: false,
+            },
+            providerReference: { type: vr_migrations_1.DataTypes.STRING, allowNull: false },
+            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,
+            tableName: "transactions",
+            modelName: "Transaction",
+            timestamps: true,
+        });
+    }
+    static associate(models) {
+        this.belongsTo(models.Payment, { foreignKey: "paymentId", as: "payment" });
+        this.belongsTo(models.User, { foreignKey: "userId", as: "user" });
+    }
+}
+exports.Transaction = Transaction;

package/dist/models/types.d.ts

@@ -0,0 +1,10 @@
+export type { UserModel } from "./user.models";
+export type { TransactionModel } from "./transaction.models";
+export type { SecurityClearanceModel } from "./securityClearance.models";
+export type { ProductModel } from "./product.models";
+export type { PricingModel } from "./pricing.models";
+export type { PaymentModel } from "./payment.models";
+export type { IdempotencyRecordModel } from "./idempotencyRecord.models";
+export type { EventLogModel } from "./eventLog.models";
+export type { DevicePaymentPlanModel } from "./devicePaymentPlan.models";
+export type { DeviceModel } from "./device.models";

package/dist/models/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/user.models.d.ts

@@ -0,0 +1,35 @@
+import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute } from "vr-migrations";
+import type { Device } from "./device.models";
+import type { Payment } from "./payment.models";
+import type { SecurityClearance } from "./securityClearance.models";
+export declare class User extends Model<InferAttributes<User>, InferCreationAttributes<User>> {
+    id: CreationOptional<string>;
+    firstName: string;
+    lastName: string;
+    phoneNumber: string;
+    jacketId: string;
+    email: CreationOptional<string | null>;
+    password: CreationOptional<string | null>;
+    securityClearanceId: string;
+    plateNumber: CreationOptional<string | null>;
+    nationalId: string;
+    isActive: CreationOptional<boolean>;
+    isSuspended: CreationOptional<boolean>;
+    bannedAt: CreationOptional<Date | null>;
+    banReason: CreationOptional<string | null>;
+    suspendedAt: CreationOptional<Date | null>;
+    suspensionReason: CreationOptional<string | null>;
+    forgotPassword: CreationOptional<boolean>;
+    otp: CreationOptional<string | null>;
+    otpExpiresAt: CreationOptional<Date | null>;
+    isDeactivated: CreationOptional<boolean>;
+    deactivatedAt: CreationOptional<Date | null>;
+    lastLoginAt: CreationOptional<Date | null>;
+    tokenVersion: CreationOptional<number>;
+    readonly createdAt: CreationOptional<Date>;
+    devices?: NonAttribute<Device[]>;
+    payments?: NonAttribute<Payment[]>;
+    securityClearance?: NonAttribute<SecurityClearance>;
+}
+export declare const initUserModel: (sequelize: any) => void;
+export type UserModel = typeof User;

package/dist/models/user.models.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initUserModel = exports.User = void 0;
+// src/models/user.models.ts
+const vr_migrations_1 = require("vr-migrations");
+class User extends vr_migrations_1.Model {
+}
+exports.User = User;
+const initUserModel = (sequelize) => {
+    User.init({
+        id: {
+            type: vr_migrations_1.DataTypes.UUID,
+            defaultValue: vr_migrations_1.DataTypes.UUIDV4,
+            primaryKey: true,
+        },
+        firstName: {
+            type: vr_migrations_1.DataTypes.STRING(100),
+            allowNull: false,
+        },
+        lastName: {
+            type: vr_migrations_1.DataTypes.STRING(100),
+            allowNull: false,
+        },
+        phoneNumber: {
+            type: vr_migrations_1.DataTypes.STRING(20),
+            allowNull: false,
+            unique: true,
+        },
+        nationalId: {
+            type: vr_migrations_1.DataTypes.STRING(16),
+            allowNull: false,
+            unique: true,
+        },
+        jacketId: {
+            type: vr_migrations_1.DataTypes.STRING(50),
+            allowNull: false,
+            unique: true,
+        },
+        email: {
+            type: vr_migrations_1.DataTypes.STRING(100),
+            allowNull: true,
+            unique: true,
+        },
+        password: {
+            type: vr_migrations_1.DataTypes.STRING,
+            allowNull: true,
+        },
+        securityClearanceId: {
+            type: vr_migrations_1.DataTypes.UUID,
+            allowNull: false,
+        },
+        plateNumber: {
+            type: vr_migrations_1.DataTypes.STRING(20),
+            allowNull: true,
+        },
+        isActive: {
+            type: vr_migrations_1.DataTypes.BOOLEAN,
+            defaultValue: true,
+        },
+        isSuspended: {
+            type: vr_migrations_1.DataTypes.BOOLEAN,
+            defaultValue: false,
+        },
+        bannedAt: {
+            type: vr_migrations_1.DataTypes.DATE,
+            allowNull: true,
+        },
+        banReason: {
+            type: vr_migrations_1.DataTypes.TEXT,
+            allowNull: true,
+        },
+        suspendedAt: {
+            type: vr_migrations_1.DataTypes.DATE,
+            allowNull: true,
+        },
+        suspensionReason: {
+            type: vr_migrations_1.DataTypes.TEXT,
+            allowNull: true,
+        },
+        lastLoginAt: {
+            type: vr_migrations_1.DataTypes.DATE,
+            allowNull: true,
+        },
+        tokenVersion: {
+            type: vr_migrations_1.DataTypes.INTEGER,
+            allowNull: false,
+            defaultValue: 1,
+        },
+        forgotPassword: {
+            type: vr_migrations_1.DataTypes.BOOLEAN,
+            defaultValue: false,
+        },
+        otp: {
+            type: vr_migrations_1.DataTypes.STRING(6),
+            allowNull: true,
+        },
+        otpExpiresAt: {
+            type: vr_migrations_1.DataTypes.DATE,
+            allowNull: true,
+        },
+        isDeactivated: {
+            type: vr_migrations_1.DataTypes.BOOLEAN,
+            defaultValue: false,
+        },
+        deactivatedAt: {
+            type: vr_migrations_1.DataTypes.DATE,
+            allowNull: true,
+        },
+        createdAt: {
+            type: vr_migrations_1.DataTypes.DATE,
+            defaultValue: vr_migrations_1.DataTypes.NOW,
+        },
+    }, {
+        sequelize,
+        modelName: "User",
+        tableName: "users",
+        timestamps: true,
+        updatedAt: false,
+        freezeTableName: true,
+    });
+};
+exports.initUserModel = initUserModel;

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "vr-models",
+  "version": "1.0.1",
+  "description": "Shared database models package for VR applications",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "npm run clean && tsc",
+    "test": "jest",
+    "version": "npm run build && git add -A dist",
+    "pub": "git add . && git commit -m \"Version update\" && npm version patch && npm publish && git push && git push --tags",
+    "prepublishOnly": "npm run build",
+    "postpublish": "git push && git push --tags"
+  },
+  "keywords": [
+    "sequelize",
+    "models",
+    "typescript",
+    "vr",
+    "database"
+  ],
+  "author": "kanu-cast",
+  "license": "MIT",
+  "dependencies": {
+    "sequelize": "^6.37.1",
+    "uuid": "^9.0.1"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.3",
+    "@types/node": "^20.11.19",
+    "rimraf": "^5.0.5",
+    "pg": "^8.11.3",
+    "pg-hstore": "^2.3.4",
+    "vr-migrations": "^1.0.3"
+  },
+  "peerDependencies": {
+    "sequelize": "^6.x",
+    "vr-migrations": "^1.0.3"
+  }
+}