vr-models 1.0.1 → 1.0.3

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

@@ -1,18 +1,44 @@
 import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute, ModelStatic } from "vr-migrations";
+import type { Payment } from "./payment.models";
+import type { User } from "./user.models";
 export type TransactionStatus = "succeeded" | "failed";
-export declare class Transaction extends Model<InferAttributes<Transaction>, InferCreationAttributes<Transaction>> {
-    id: CreationOptional<string>;
+export interface TransactionAttributes {
+    id: string;
     userId: string;
     paymentId: string;
     amount: number;
     status: TransactionStatus;
     providerReference: string;
     metadata: Record<string, any>;
+    createdAt: Date;
+    updatedAt: Date;
+    payment?: Payment;
+    user?: User;
+}
+export interface TransactionCreationAttributes extends Omit<TransactionAttributes, "id" | "createdAt" | "updatedAt" | "metadata"> {
+    id?: string;
+    metadata?: Record<string, any>;
+}
+export declare class Transaction extends Model<InferAttributes<Transaction>, InferCreationAttributes<Transaction>> implements TransactionAttributes {
+    id: CreationOptional<string>;
+    userId: string;
+    paymentId: string;
+    amount: number;
+    status: TransactionStatus;
+    providerReference: string;
+    metadata: CreationOptional<Record<string, any>>;
     readonly createdAt: CreationOptional<Date>;
     readonly updatedAt: CreationOptional<Date>;
-    payment?: NonAttribute<any>;
-    user?: NonAttribute<any>;
+    payment?: NonAttribute<Payment>;
+    user?: NonAttribute<User>;
     static initialize(sequelize: any): void;
     static associate(models: Record<string, ModelStatic<Model>>): void;
+    markAsSucceeded(metadata?: Record<string, any>): Promise<void>;
+    markAsFailed(reason: string, metadata?: Record<string, any>): Promise<void>;
+    isSuccessful(): boolean;
+    isFailed(): boolean;
+    getFormattedAmount(): string;
+    static getUserTransactions(userId: string, limit?: number): Promise<Transaction[]>;
+    static getPaymentTransactions(paymentId: string): Promise<Transaction[]>;
 }
 export type TransactionModel = typeof Transaction;

package/dist/models/transaction.models.js

@@ -3,6 +3,7 @@ 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 initialization method
     static initialize(sequelize) {
         this.init({
             id: {
@@ -22,7 +23,11 @@ class Transaction extends vr_migrations_1.Model {
                 allowNull: false,
             },
             providerReference: { type: vr_migrations_1.DataTypes.STRING, allowNull: false },
-            metadata: { type: vr_migrations_1.DataTypes.JSONB, allowNull: false, defaultValue: {} },
+            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 },
         }, {
@@ -32,9 +37,61 @@ class Transaction extends vr_migrations_1.Model {
             timestamps: true,
         });
     }
+    // Static association method
     static associate(models) {
-        this.belongsTo(models.Payment, { foreignKey: "paymentId", as: "payment" });
-        this.belongsTo(models.User, { foreignKey: "userId", as: "user" });
+        this.belongsTo(models.Payment, {
+            foreignKey: "paymentId",
+            as: "payment",
+            onDelete: "CASCADE",
+            onUpdate: "CASCADE",
+        });
+        this.belongsTo(models.User, {
+            foreignKey: "userId",
+            as: "user",
+            onDelete: "RESTRICT",
+            onUpdate: "CASCADE",
+        });
+    }
+    // Custom instance methods
+    async markAsSucceeded(metadata) {
+        this.status = "succeeded";
+        if (metadata) {
+            this.metadata = { ...this.metadata, ...metadata };
+        }
+        await this.save();
+    }
+    async markAsFailed(reason, metadata) {
+        this.status = "failed";
+        const failureMetadata = {
+            failureReason: reason,
+            failedAt: new Date().toISOString(),
+            ...metadata,
+        };
+        this.metadata = { ...this.metadata, ...failureMetadata };
+        await this.save();
+    }
+    isSuccessful() {
+        return this.status === "succeeded";
+    }
+    isFailed() {
+        return this.status === "failed";
+    }
+    getFormattedAmount() {
+        return `RWF ${this.amount.toLocaleString()}`;
+    }
+    static async getUserTransactions(userId, limit = 50) {
+        return await this.findAll({
+            where: { userId },
+            order: [["createdAt", "DESC"]],
+            limit,
+            include: ["payment"],
+        });
+    }
+    static async getPaymentTransactions(paymentId) {
+        return await this.findAll({
+            where: { paymentId },
+            order: [["createdAt", "DESC"]],
+        });
     }
 }
 exports.Transaction = Transaction;

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

@@ -1,8 +1,45 @@
-import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute } from "vr-migrations";
+import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute, ModelStatic } 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>> {
+export interface UserAttributes {
+    id: string;
+    firstName: string;
+    lastName: string;
+    phoneNumber: string;
+    jacketId: string;
+    email: string | null;
+    password: string | null;
+    securityClearanceId: string;
+    plateNumber: string | null;
+    nationalId: string;
+    isActive: boolean;
+    isSuspended: boolean;
+    bannedAt: Date | null;
+    banReason: string | null;
+    suspendedAt: Date | null;
+    suspensionReason: string | null;
+    forgotPassword: boolean;
+    otp: string | null;
+    otpExpiresAt: Date | null;
+    isDeactivated: boolean;
+    deactivatedAt: Date | null;
+    lastLoginAt: Date | null;
+    tokenVersion: number;
+    createdAt: Date;
+    devices?: Device[];
+    payments?: Payment[];
+    securityClearance?: SecurityClearance;
+}
+export interface UserCreationAttributes extends Omit<UserAttributes, "id" | "createdAt" | "isActive" | "isSuspended" | "forgotPassword" | "isDeactivated" | "tokenVersion"> {
+    id?: string;
+    isActive?: boolean;
+    isSuspended?: boolean;
+    forgotPassword?: boolean;
+    isDeactivated?: boolean;
+    tokenVersion?: number;
+}
+export declare class User extends Model<InferAttributes<User>, InferCreationAttributes<User>> implements UserAttributes {
     id: CreationOptional<string>;
     firstName: string;
     lastName: string;
@@ -30,6 +67,17 @@ export declare class User extends Model<InferAttributes<User>, InferCreationAttr
     devices?: NonAttribute<Device[]>;
     payments?: NonAttribute<Payment[]>;
     securityClearance?: NonAttribute<SecurityClearance>;
+    static initialize(sequelize: any): void;
+    static associate(models: Record<string, ModelStatic<Model>>): void;
+    updateLastLogin(): Promise<void>;
+    generateOTP(): Promise<string>;
+    clearOTP(): Promise<void>;
+    validateOTP(otp: string): Promise<boolean>;
+    suspend(reason: string): Promise<void>;
+    unsuspend(): Promise<void>;
+    ban(reason: string): Promise<void>;
+    unban(): Promise<void>;
+    deactivate(): Promise<void>;
+    activate(): Promise<void>;
 }
-export declare const initUserModel: (sequelize: any) => void;
 export type UserModel = typeof User;

package/dist/models/user.models.js

@@ -1,122 +1,202 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initUserModel = exports.User = void 0;
+exports.User = void 0;
 // src/models/user.models.ts
 const vr_migrations_1 = require("vr-migrations");
 class User 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,
+            },
+            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,
+        });
+    }
+    // Static association method
+    static associate(models) {
+        this.belongsTo(models.SecurityClearance, {
+            foreignKey: "securityClearanceId",
+            as: "securityClearance",
+            onDelete: "RESTRICT",
+            onUpdate: "CASCADE",
+        });
+        this.hasMany(models.Device, {
+            foreignKey: "userId",
+            as: "devices",
+            onDelete: "CASCADE",
+            onUpdate: "CASCADE",
+        });
+        this.hasMany(models.Payment, {
+            foreignKey: "userId",
+            as: "payments",
+            onDelete: "CASCADE",
+            onUpdate: "CASCADE",
+        });
+    }
+    // Custom instance methods (example methods)
+    async updateLastLogin() {
+        this.lastLoginAt = new Date();
+        await this.save();
+    }
+    async generateOTP() {
+        const otp = Math.floor(100000 + Math.random() * 900000).toString();
+        const expires = new Date();
+        expires.setMinutes(expires.getMinutes() + 15); // OTP valid for 15 minutes
+        this.otp = otp;
+        this.otpExpiresAt = expires;
+        this.forgotPassword = true;
+        await this.save();
+        return otp;
+    }
+    async clearOTP() {
+        this.otp = null;
+        this.otpExpiresAt = null;
+        this.forgotPassword = false;
+        await this.save();
+    }
+    async validateOTP(otp) {
+        if (!this.otp || !this.otpExpiresAt || this.otp !== otp) {
+            return false;
+        }
+        return new Date() < this.otpExpiresAt;
+    }
+    async suspend(reason) {
+        this.isSuspended = true;
+        this.suspendedAt = new Date();
+        this.suspensionReason = reason;
+        await this.save();
+    }
+    async unsuspend() {
+        this.isSuspended = false;
+        this.suspendedAt = null;
+        this.suspensionReason = null;
+        await this.save();
+    }
+    async ban(reason) {
+        this.bannedAt = new Date();
+        this.banReason = reason;
+        await this.save();
+    }
+    async unban() {
+        this.bannedAt = null;
+        this.banReason = null;
+        await this.save();
+    }
+    async deactivate() {
+        this.isDeactivated = true;
+        this.deactivatedAt = new Date();
+        await this.save();
+    }
+    async activate() {
+        this.isDeactivated = false;
+        this.deactivatedAt = null;
+        await this.save();
+    }
 }
 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

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