vr-models 1.0.57 → 1.0.58

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

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

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

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

package/dist/models/index.d.ts

@@ -12,5 +12,5 @@ export * from "./installment.models";
 export * from "./ban.models";
 export * from "./suspension.models";
 export * from "./appSpecs.models";
-export * from "./phoneContact.models";
-export type { UserModel, SecurityClearanceModel, ProductModel, PricingModel, PaymentModel, PaymentEventLogModel, IdempotencyRecordModel, EventLogModel, DevicePaymentPlanModel, DeviceModel, InstallmentModel, BanModel, SuspensionModel, AppSpecsModel, PhoneContactModel, } from "./types";
+export * from "./contact.models";
+export type { UserModel, SecurityClearanceModel, ProductModel, PricingModel, PaymentModel, PaymentEventLogModel, IdempotencyRecordModel, EventLogModel, DevicePaymentPlanModel, DeviceModel, InstallmentModel, BanModel, SuspensionModel, AppSpecsModel, ContactModel, } from "./types";

package/dist/models/index.js

@@ -28,4 +28,4 @@ __exportStar(require("./installment.models"), exports);
 __exportStar(require("./ban.models"), exports);
 __exportStar(require("./suspension.models"), exports);
 __exportStar(require("./appSpecs.models"), exports);
-__exportStar(require("./phoneContact.models"), exports);
+__exportStar(require("./contact.models"), exports);

package/dist/models/types.d.ts

@@ -11,5 +11,5 @@ export type { InstallmentModel } from "./installment.models";
 export type { BanModel } from "./ban.models";
 export type { SuspensionModel } from "./suspension.models";
 export type { AppSpecsModel } from "./appSpecs.models";
-export type { PhoneContactModel } from "./phoneContact.models";
+export type { ContactModel } from "./contact.models";
 export type { PaymentEventLogModel } from "./paymentEventLog.models";

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

@@ -1,7 +1,8 @@
 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";
-import type { PhoneContact } from "./phoneContact.models";
+import type { Contact } from "./contact.models";
 import { Ban } from "./ban.models";
 import { Suspension } from "./suspension.models";
 import { DevicePaymentPlan } from "./devicePaymentPlan.models";
@@ -18,7 +19,6 @@ export interface UserAttributes {
     firstName: string;
     lastName: string;
     jacketId?: string | null;
-    email?: string | null;
     password?: string | null;
     securityClearanceId: string;
     plateNumber?: string | null;
@@ -26,7 +26,7 @@ export interface UserAttributes {
     birthDate?: number | null;
     birthMonth?: number | null;
     birthYear?: number | null;
-    primaryPhoneId: string | null;
+    primaryContactId: string | null;
     isActive: boolean;
     forgotPassword: boolean;
     isDeactivated: boolean;
@@ -37,25 +37,25 @@ export interface UserAttributes {
     createdAt: Date;
     payments?: Payment[];
     securityClearance?: SecurityClearance;
-    primaryPhone?: PhoneContact;
-    phones?: PhoneContact[];
+    primaryContact?: Contact;
+    contacts?: Contact[];
     bans?: Ban[];
     suspensions?: Suspension[];
+    devices?: Device[];
 }
-export interface UserCreationAttributes extends Omit<UserAttributes, "id" | "createdAt" | "isActive" | "forgotPassword" | "isDeactivated" | "tokenVersion" | "primaryPhoneId"> {
+export interface UserCreationAttributes extends Omit<UserAttributes, "id" | "createdAt" | "isActive" | "forgotPassword" | "isDeactivated" | "tokenVersion" | "primaryContactId"> {
     id?: string;
     isActive?: boolean;
     forgotPassword?: boolean;
     isDeactivated?: boolean;
     tokenVersion?: number;
-    primaryPhoneId?: string | null;
+    primaryContactId?: string | null;
 }
 export declare class User extends Model<InferAttributes<User>, InferCreationAttributes<User>> implements UserAttributes {
     id: CreationOptional<string>;
     firstName: string;
     lastName: string;
     jacketId: CreationOptional<string | null>;
-    email: CreationOptional<string | null>;
     password: CreationOptional<string | null>;
     securityClearanceId: string;
     plateNumber: CreationOptional<string | null>;
@@ -63,7 +63,7 @@ export declare class User extends Model<InferAttributes<User>, InferCreationAttr
     birthDate: CreationOptional<number | null>;
     birthMonth: CreationOptional<number | null>;
     birthYear: CreationOptional<number | null>;
-    primaryPhoneId: CreationOptional<string | null>;
+    primaryContactId: CreationOptional<string | null>;
     isActive: CreationOptional<boolean>;
     forgotPassword: CreationOptional<boolean>;
     isDeactivated: CreationOptional<boolean>;
@@ -75,8 +75,8 @@ export declare class User extends Model<InferAttributes<User>, InferCreationAttr
     payments?: NonAttribute<Payment[]>;
     paymentPlans?: NonAttribute<DevicePaymentPlan[]>;
     securityClearance?: NonAttribute<SecurityClearance>;
-    primaryPhone?: NonAttribute<PhoneContact>;
-    phones?: NonAttribute<PhoneContact[]>;
+    primaryContact?: NonAttribute<Contact>;
+    contacts?: NonAttribute<Contact[]>;
     bans?: NonAttribute<Ban[]>;
     suspensions?: NonAttribute<Suspension[]>;
     static initialize(sequelize: any): void;
@@ -85,7 +85,8 @@ export declare class User extends Model<InferAttributes<User>, InferCreationAttr
     updateLastLogin(): Promise<void>;
     deactivate(): Promise<void>;
     activate(): Promise<void>;
-    hasVerifiedPhone(): Promise<boolean>;
+    getPrimaryVerifiedContact(): Promise<Contact | null>;
+    hasVerifiedContactType(type: "EMAIL" | "PHONE" | "WHATSAPP"): Promise<boolean>;
     getBirthDate(): Date | null;
     getAge(): number | null;
 }

package/dist/models/user.models.js

@@ -5,8 +5,11 @@ exports.User = exports.GENDER_OPTIONS = void 0;
 const vr_migrations_1 = require("vr-migrations");
 // ==================== GENDER OPTIONS ====================
 exports.GENDER_OPTIONS = ["male", "female"];
+// ==================== USER MODEL ====================
 class User extends vr_migrations_1.Model {
-    // Static initialization method
+    // ===========================================================================
+    // INITIALIZATION
+    // ===========================================================================
     static initialize(sequelize) {
         this.init({
             id: {
@@ -27,11 +30,6 @@ class User extends vr_migrations_1.Model {
                 allowNull: true,
                 unique: true,
             },
-            email: {
-                type: vr_migrations_1.DataTypes.STRING(100),
-                allowNull: true,
-                unique: true,
-            },
             password: {
                 type: vr_migrations_1.DataTypes.STRING,
                 allowNull: true,
@@ -73,7 +71,7 @@ class User extends vr_migrations_1.Model {
                     max: new Date().getFullYear(),
                 },
             },
-            primaryPhoneId: {
+            primaryContactId: {
                 type: vr_migrations_1.DataTypes.UUID,
                 allowNull: true,
             },
@@ -125,7 +123,9 @@ class User extends vr_migrations_1.Model {
             freezeTableName: true,
         });
     }
-    // Static association method
+    // ===========================================================================
+    // ASSOCIATIONS
+    // ===========================================================================
     static associate(models) {
         this.belongsTo(models.SecurityClearance, {
             foreignKey: "securityClearanceId",
@@ -133,15 +133,16 @@ class User extends vr_migrations_1.Model {
             onDelete: "RESTRICT",
             onUpdate: "CASCADE",
         });
-        this.belongsTo(models.PhoneContact, {
-            foreignKey: "primaryPhoneId",
-            as: "primaryPhone",
+        // NEW: Contact associations (renamed from PhoneContact)
+        this.belongsTo(models.Contact, {
+            foreignKey: "primaryContactId",
+            as: "primaryContact",
             onDelete: "SET NULL",
             onUpdate: "CASCADE",
         });
-        this.hasMany(models.PhoneContact, {
+        this.hasMany(models.Contact, {
             foreignKey: "userId",
-            as: "phones",
+            as: "contacts",
             onDelete: "SET NULL",
             onUpdate: "CASCADE",
         });
@@ -170,7 +171,9 @@ class User extends vr_migrations_1.Model {
             onUpdate: "CASCADE",
         });
     }
-    // Custom instance methods
+    // ===========================================================================
+    // CUSTOM INSTANCE METHODS
+    // ===========================================================================
     async softDelete(deletedBy, reason) {
         this.deletion = {
             deleted: true,
@@ -195,18 +198,25 @@ class User extends vr_migrations_1.Model {
         this.deactivatedAt = null;
         await this.save();
     }
-    // Helper to check if user has verified phone
-    async hasVerifiedPhone() {
-        const PhoneContact = this.constructor.sequelize.models
-            .PhoneContact;
-        const verifiedPhone = await PhoneContact.findOne({
-            where: {
-                userId: this.id,
-                isVerified: true,
-                isActive: true,
-            },
-        });
-        return !!verifiedPhone;
+    // Helper to get primary verified contact
+    async getPrimaryVerifiedContact() {
+        if (this.primaryContactId) {
+            const ContactModel = this.constructor.sequelize.models.Contact;
+            return await ContactModel.findOne({
+                where: {
+                    id: this.primaryContactId,
+                    isVerified: true,
+                    isActive: true,
+                },
+            });
+        }
+        return null;
+    }
+    // Helper to check if user has a verified contact of a specific type
+    async hasVerifiedContactType(type) {
+        if (!this.contacts)
+            return false;
+        return this.contacts.some((contact) => contact.type === type && contact.isVerified && contact.isActive);
     }
     // Helper to get full birth date as Date object
     getBirthDate() {

package/package.json

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

package/dist/models/phoneContact.models.d.ts

@@ -1,71 +0,0 @@
-import { Model, InferAttributes, InferCreationAttributes, CreationOptional, NonAttribute, ModelStatic } from "vr-migrations";
-import type { User } from "./user.models";
-export interface PhoneContactAttributes {
-    id: string;
-    phoneNumber: string;
-    userId: string | null;
-    isVerified: boolean;
-    verifiedAt: Date | null;
-    isPrimary: boolean;
-    isActive: boolean;
-    otp: string | null;
-    otpExpiresAt: Date | null;
-    metadata: {
-        lastOtpSentAt?: Date;
-        otpAttempts?: number;
-        lastFailedAttemptAt?: Date;
-        isLocked?: boolean;
-        lockedUntil: Date | null;
-        carrier?: string;
-        countryCode?: string;
-        deactivatedAt?: Date | null;
-        deactivationReason?: string;
-    };
-    createdAt: Date;
-    updatedAt: Date;
-    user?: NonAttribute<User>;
-}
-export interface PhoneContactCreationAttributes extends Omit<PhoneContactAttributes, "id" | "createdAt" | "updatedAt" | "metadata"> {
-    id?: string;
-    metadata?: Record<string, any>;
-}
-export declare class PhoneContact extends Model<InferAttributes<PhoneContact>, InferCreationAttributes<PhoneContact>> implements PhoneContactAttributes {
-    id: CreationOptional<string>;
-    phoneNumber: string;
-    userId: CreationOptional<string | null>;
-    isVerified: CreationOptional<boolean>;
-    verifiedAt: CreationOptional<Date | null>;
-    isPrimary: CreationOptional<boolean>;
-    isActive: CreationOptional<boolean>;
-    otp: CreationOptional<string | null>;
-    otpExpiresAt: CreationOptional<Date | null>;
-    metadata: CreationOptional<{
-        lastOtpSentAt?: Date;
-        otpAttempts?: number;
-        lastFailedAttemptAt?: Date;
-        isLocked?: boolean;
-        lockedUntil: Date | null;
-        carrier?: string;
-        countryCode?: string;
-        deactivatedAt?: Date | null;
-        deactivationReason?: string;
-    }>;
-    readonly createdAt: CreationOptional<Date>;
-    readonly updatedAt: CreationOptional<Date>;
-    user?: NonAttribute<User>;
-    static initialize(sequelize: any): void;
-    static associate(models: Record<string, ModelStatic<Model>>): void;
-    deactivate(reason?: string): Promise<void>;
-    reactivate(): Promise<void>;
-    isLocked(): boolean;
-    getRemainingLockTime(): number | null;
-    isExpired(): boolean;
-    getRemainingOTPTime(): number | null;
-    static findByPhoneNumber(phoneNumber: string): Promise<PhoneContact | null>;
-    static findVerifiedByPhoneNumber(phoneNumber: string): Promise<PhoneContact | null>;
-    static getUserPrimaryPhone(userId: string): Promise<PhoneContact | null>;
-    static getUserPhones(userId: string): Promise<PhoneContact[]>;
-    static isPhoneNumberAvailable(phoneNumber: string): Promise<boolean>;
-    static cleanupExpiredOTPs(): Promise<void>;
-}
-export type PhoneContactModel = typeof PhoneContact;