@valentine-efagene/qshelter-common 1.0.0 → 1.0.3

package/entities/mortgage-downpayment-payment.entity.ts

@@ -1,61 +0,0 @@
-import { Column, Entity, JoinColumn, ManyToOne } from 'typeorm';
-import { AbstractBaseEntity } from './common.pure.entity';
-import { MortgageDownpaymentPlan } from './mortgage-downpayment.entity';
-import { MortgageDownpaymentInstallment } from './mortgage-downpayment-installment.entity';
-import { User } from './user.entity';
-
-// Legacy enum - kept for backward compatibility
-export enum DownpaymentPaymentStatus {
-    PENDING = 'PENDING',
-    COMPLETED = 'COMPLETED',
-    FAILED = 'FAILED',
-}
-
-// Payment state for FSM tracking
-export enum PaymentState {
-    INITIATED = 'INITIATED',
-    COMPLETED = 'COMPLETED',
-    FAILED = 'FAILED',
-}
-
-@Entity({ name: 'mortgage_downpayment_payment' })
-export class MortgageDownpaymentPayment extends AbstractBaseEntity {
-    @ManyToOne(() => MortgageDownpaymentPlan, { onDelete: 'CASCADE' })
-    @JoinColumn({ name: 'plan_id' })
-    plan: MortgageDownpaymentPlan;
-
-    @Column({ nullable: true })
-    planId: number;
-
-    @ManyToOne(() => MortgageDownpaymentInstallment, { nullable: true })
-    @JoinColumn({ name: 'installment_id' })
-    installment: MortgageDownpaymentInstallment;
-
-    @Column({ nullable: true })
-    installmentId: number;
-
-    @ManyToOne(() => User, { nullable: true })
-    @JoinColumn({ name: 'payer_id' })
-    payer: User;
-
-    @Column({ nullable: true })
-    payerId: number;
-
-    @Column({ type: 'double precision' })
-    amount: number;
-
-    @Column({ nullable: true, unique: true })
-    providerReference: string;
-
-    @Column({ type: 'enum', enum: DownpaymentPaymentStatus, default: DownpaymentPaymentStatus.PENDING })
-    status: DownpaymentPaymentStatus;
-
-    // FSM state tracking
-    @Column({ type: 'enum', enum: PaymentState, default: PaymentState.INITIATED })
-    state: PaymentState;
-
-    @Column({ type: 'text', nullable: true })
-    stateMetadata: string; // JSON metadata for state transitions
-}
-
-export default MortgageDownpaymentPayment;

package/entities/mortgage-downpayment.entity.ts

@@ -1,43 +0,0 @@
-import { Column, Entity, JoinColumn, ManyToOne, OneToMany } from 'typeorm';
-import { AbstractBaseEntity } from './common.pure.entity';
-import { Mortgage } from './mortgage.entity';
-import { MortgageDownpaymentInstallment } from './mortgage-downpayment-installment.entity';
-import { Frequency } from '../types/common.type';
-
-export enum DownpaymentPlanStatus {
-    PENDING = 'PENDING',
-    ACTIVE = 'ACTIVE',
-    COMPLETED = 'COMPLETED',
-    DEFAULTED = 'DEFAULTED',
-    CANCELLED = 'CANCELLED',
-}
-
-@Entity({ name: 'mortgage_downpayment_plan' })
-export class MortgageDownpaymentPlan extends AbstractBaseEntity {
-    @ManyToOne(() => Mortgage, { onDelete: 'CASCADE' })
-    @JoinColumn({ name: 'mortgage_id' })
-    mortgage: Mortgage;
-
-    @Column({ nullable: true })
-    mortgageId: number;
-
-    @Column({ type: 'double precision' })
-    totalAmount: number;
-
-    @Column({ type: 'int', nullable: true })
-    installmentCount: number;
-
-    @Column({ nullable: true, type: 'enum', enum: Frequency })
-    frequency: Frequency;
-
-    @Column({ type: 'date', nullable: true })
-    startDate: Date;
-
-    @Column({ type: 'enum', enum: DownpaymentPlanStatus, default: DownpaymentPlanStatus.PENDING })
-    status: DownpaymentPlanStatus;
-
-    @OneToMany(() => MortgageDownpaymentInstallment, (i) => i.plan, { cascade: true })
-    installments: MortgageDownpaymentInstallment[];
-}
-
-export default MortgageDownpaymentPlan;

package/entities/mortgage-step.entity.ts

@@ -1,33 +0,0 @@
-import { Column, Entity, JoinColumn, ManyToOne } from 'typeorm';
-import { AbstractBaseReviewableEntity } from './common.entity';
-import { Mortgage } from './mortgage.entity';
-
-@Entity({ name: 'mortgage_step' })
-export class MortgageStep extends AbstractBaseReviewableEntity {
-    @ManyToOne(() => Mortgage, (mortgage) => mortgage.steps, { onDelete: 'CASCADE' })
-    @JoinColumn({ name: 'mortgage_id' })
-    mortgage: Mortgage;
-
-    @Column({ nullable: true })
-    mortgageId: number;
-
-    @Column()
-    title: string;
-
-    @Column({ type: 'text', nullable: true })
-    description: string;
-
-    // Sequence order - easier to query and reorder than relying purely on linked-list pointers
-    @Column({ type: 'int', default: 0 })
-    sequence: number;
-
-    // We use `sequence` for ordering. Removed linked-list pointer fields (nextStep/nextStepId) to reduce redundancy.
-
-    @Column({ default: false })
-    isOptional: boolean;
-
-    @Column({ nullable: true })
-    completedAt: Date;
-}
-
-export default MortgageStep;

package/entities/mortgage-type.entity.ts

@@ -1,31 +0,0 @@
-import { Column, Entity } from 'typeorm';
-import { AbstractBaseReviewableEntity } from './common.entity';
-
-/**
- * MortgageType stores named mortgage configurations. Examples: 'Standard Fixed', 'Interest Only', 'Buy-to-Let'.
- * - defaultSteps: array of step templates { title, description?, sequence?, isOptional? }
- * - requiredDocuments: array of document templates { name, required: boolean }
- * - config: free-form JSON for additional settings
- */
-@Entity({ name: 'mortgage_type' })
-export class MortgageType extends AbstractBaseReviewableEntity {
-    @Column()
-    name: string;
-
-    @Column({ nullable: true })
-    slug: string;
-
-    @Column({ type: 'text', nullable: true })
-    description?: string;
-
-    @Column({ type: 'json', nullable: true })
-    defaultSteps?: any[];
-
-    @Column({ type: 'json', nullable: true })
-    requiredDocuments?: any[];
-
-    @Column({ type: 'json', nullable: true })
-    config?: any;
-}
-
-export default MortgageType;

package/entities/mortgage.entity.ts

@@ -1,89 +0,0 @@
-import { Column, Entity, JoinColumn, ManyToOne, OneToMany, OneToOne } from 'typeorm';
-import { AbstractBaseReviewableEntity } from './common.entity';
-import { Property } from './property.entity';
-import { User } from './user.entity';
-import MortgageDocument from './mortgage-document.entity';
-import MortgageStep from './mortgage-step.entity';
-import { MortgageType } from './mortgage-type.entity';
-import { MortgageDownpaymentPlan } from './mortgage-downpayment.entity';
-import { MortgageState } from '../types/mortgage-fsm.types';
-
-// Legacy enum - kept for backward compatibility
-export enum MortgageStatus {
-    DRAFT = 'DRAFT',
-    PENDING = 'PENDING',
-    ACTIVE = 'ACTIVE',
-    COMPLETED = 'COMPLETED',
-    CANCELLED = 'CANCELLED',
-}
-
-@Entity({ name: 'mortgage' })
-export class Mortgage extends AbstractBaseReviewableEntity {
-    @ManyToOne(() => Property, (property) => property.mortgages, { onDelete: 'CASCADE' })
-    @JoinColumn({ name: 'property_id' })
-    property: Property;
-
-    @Column({ nullable: true })
-    propertyId: number;
-
-    @ManyToOne(() => User, { nullable: true })
-    @JoinColumn({ name: 'borrower_id' })
-    borrower: User;
-
-    @Column({ nullable: true })
-    borrowerId: number;
-
-    @Column({ type: 'double precision', nullable: true })
-    principal: number;
-
-    @Column({ type: 'double precision', nullable: true })
-    downPayment: number;
-
-    @Column({ type: 'int', nullable: true })
-    termMonths: number;
-
-    @Column({ type: 'double precision', nullable: true })
-    interestRate: number;
-
-    @Column({ type: 'double precision', nullable: true })
-    monthlyPayment: number;
-
-    @Column({ type: 'enum', enum: MortgageStatus, default: MortgageStatus.DRAFT })
-    status: MortgageStatus;
-
-    // FSM State - Primary state tracking
-    @Column({ type: 'varchar', default: MortgageState.DRAFT })
-    state: string; // Using string to store MortgageState enum values
-
-    // FSM Metadata - Stores transition history and context
-    @Column({ type: 'text', nullable: true })
-    stateMetadata: string; // JSON string containing last transition info
-
-    @OneToMany(() => MortgageDocument, (doc) => doc.mortgage)
-    documents: MortgageDocument[];
-
-    @OneToMany(() => MortgageStep, (step) => step.mortgage, { cascade: true })
-    steps: MortgageStep[];
-
-    @ManyToOne(() => MortgageType, { nullable: true })
-    @JoinColumn({ name: 'mortgage_type_id' })
-    mortgageType: MortgageType;
-
-    @Column({ nullable: true })
-    mortgageTypeId: number;
-
-    @Column({ type: 'timestamp', nullable: true })
-    lastReminderSentAt: Date;
-
-    @OneToOne(() => MortgageDownpaymentPlan, { nullable: true })
-    @JoinColumn({ name: 'downpayment_plan_id' })
-    downpaymentPlan: MortgageDownpaymentPlan;
-
-    @Column({ nullable: true })
-    downpaymentPlanId: number;
-
-    @Column({ type: 'double precision', nullable: true })
-    downPaymentPaid: number;
-}
-
-export default Mortgage;

package/entities/password_reset_tokens.entity.ts

@@ -1,25 +0,0 @@
-import { Column, DeleteDateColumn, Entity, JoinColumn, OneToOne } from 'typeorm';
-import { User } from './user.entity';
-import { BaseEntity } from './BaseEntity';
-
-@Entity({ name: 'password_reset_token' })
-export class PasswordResetToken extends BaseEntity {
-  @OneToOne(() => User, {
-    //eager: true,
-    onDelete: 'CASCADE',
-    onUpdate: 'CASCADE',
-  })
-  @JoinColumn({ name: 'user_id' })
-  user: User;
-
-  @Column({
-    nullable: true
-  })
-  tokenHash: string
-
-  @DeleteDateColumn({
-    nullable: true,
-    default: null
-  })
-  expiresAt: Date;
-}

package/entities/permission.entity.ts

@@ -1,12 +0,0 @@
-import { Column, Entity, ManyToMany } from 'typeorm';
-import { BaseEntity } from './BaseEntity';
-import { Role } from './role.entity';
-
-@Entity({ name: 'permissions' })
-export class Permission extends BaseEntity {
-  @Column({ type: 'varchar', nullable: true })
-  name: string;
-
-  @ManyToMany(() => Role, role => role.permissions)
-  roles: Role[]
-}

package/entities/property-document.entity.ts

@@ -1,21 +0,0 @@
-import {
-  Column,
-  Entity,
-  JoinColumn,
-  ManyToOne,
-} from 'typeorm';
-import { Property } from './property.entity';
-import { AbstractBaseDocumentEntity } from './common.entity';
-
-@Entity({ name: 'property-document' })
-export class PropertyDocument extends AbstractBaseDocumentEntity {
-  @ManyToOne(() => Property, (property) => property.documents, {
-    onDelete: 'CASCADE',
-    onUpdate: 'CASCADE',
-  })
-  @JoinColumn({ name: 'property_id' })
-  property: Property;
-
-  @Column()
-  propertyId: number;
-}

package/entities/property-media.entity.ts

@@ -1,23 +0,0 @@
-import {
-  Column,
-  Entity,
-  JoinColumn,
-  ManyToOne,
-} from 'typeorm';
-import { Property } from './property.entity';
-import { AbstractBaseMediaEntity } from './common.entity';
-
-@Entity({ name: 'property_media' })
-export class PropertyMedia extends AbstractBaseMediaEntity {
-  @ManyToOne(() => Property, (property) => property.media, {
-    onDelete: 'CASCADE',
-    onUpdate: 'CASCADE',
-  })
-  @JoinColumn({ name: 'property_id' })
-  property: Property;
-
-  @Column({
-    nullable: false
-  })
-  propertyId: number
-}

package/entities/property.entity.ts

@@ -1,147 +0,0 @@
-import { Column, Entity, JoinColumn, JoinTable, ManyToMany, ManyToOne, OneToMany, OneToOne } from 'typeorm';
-import { PropertyDocument } from './property-document.entity';
-import { PropertyMedia } from './property-media.entity';
-import { User } from './user.entity';
-import { Amenity } from './amenity.entity';
-import { AbstractBaseReviewableEntity } from './common.entity';
-import { Mortgage } from './mortgage.entity';
-import { PropertyStatus, PropertyType } from '../types/property.type';
-import { Currency, PropertyCategory } from '../types/social.enums';
-
-@Entity({ name: 'property' })
-export class Property extends AbstractBaseReviewableEntity {
-  @ManyToOne(() => User, {
-    //eager: true,
-    onDelete: 'CASCADE',
-    onUpdate: 'CASCADE',
-  })
-  @JoinColumn({ name: 'user_id' })
-  user: User;
-
-  @Column({ nullable: true })
-  userId: number;
-
-  @OneToMany(
-    () => PropertyDocument,
-    (propertyDocument) => propertyDocument.property,
-  )
-  documents: PropertyDocument[];
-
-  @ManyToMany(() => Amenity)
-  @JoinTable()
-  amenities: Amenity[]
-
-  @OneToMany(
-    () => PropertyMedia,
-    (propertyDocument) => propertyDocument.property,
-  )
-
-  media: PropertyMedia[];
-
-  @OneToMany(() => Mortgage, (mortgage) => mortgage.property)
-  mortgages: Mortgage[];
-  @OneToOne(() => PropertyMedia, {
-    onDelete: 'SET NULL', // prevents FK errors if image is deleted
-    onUpdate: 'CASCADE'
-  })
-  @JoinColumn({ name: 'display_image_id' })
-  displayImage: PropertyMedia;
-
-  @Column({
-    nullable: true
-  })
-  displayImageId: number
-
-  @Column({ nullable: true })
-  title: string;
-
-  @Column({
-    nullable: true,
-    type: 'enum',
-    enum: PropertyCategory,
-  })
-  category: PropertyCategory;
-
-  @Column({
-    nullable: true,
-    type: 'enum',
-    enum: PropertyType
-  })
-  propertyType: string;
-
-  @Column({ nullable: true })
-  country: string;
-
-  @Column({
-    nullable: true,
-    type: 'enum',
-    enum: Currency,
-  })
-  currency: Currency;
-
-  @Column({ nullable: true })
-  city: string;
-
-  @Column({ nullable: true })
-  district: string;
-
-  @Column({ nullable: true })
-  zipCode: string;
-
-  @Column({ nullable: true })
-  streetAddress: string;
-
-  @Column({ nullable: false })
-  nBedrooms: string
-
-  @Column({ nullable: false })
-  nBathrooms: string
-
-  @Column({ nullable: false })
-  nParkingSpots: string
-
-  @Column({
-    type: 'double precision',
-    scale: 2,
-    precision: 20,
-    nullable: true,
-  })
-  price: number
-
-  @Column({
-    type: 'double precision',
-    scale: 2,
-    precision: 20,
-    nullable: true,
-  })
-  longitude: number
-
-  @Column({
-    type: 'double precision',
-    scale: 2,
-    precision: 20,
-    nullable: true,
-  })
-  latitude: number
-
-  @Column({
-    type: 'double precision',
-    scale: 2,
-    precision: 20,
-    nullable: true,
-  })
-  area: number
-
-  @Column({
-    type: 'text',
-    nullable: true
-  })
-  description: string
-
-  @Column({
-    type: 'enum',
-    enum: PropertyStatus,
-    default: PropertyStatus.PENDING,
-  })
-  status: PropertyStatus;
-}

package/entities/refresh_token.entity.ts

@@ -1,16 +0,0 @@
-import { Column, Entity, JoinColumn, ManyToOne } from 'typeorm';
-import { BaseEntity } from './BaseEntity';
-import { User } from './user.entity';
-
-@Entity({ name: 'refresh_tokens' })
-export class RefreshToken extends BaseEntity {
-  @ManyToOne(() => User, (user) => user.refreshTokens)
-  @JoinColumn({ name: 'user_id' })
-  user: User;
-
-  @Column({ nullable: true })
-  userId: number;
-
-  @Column({ nullable: false, type: 'text' })
-  token: string;
-}

package/entities/role.entity.ts

@@ -1,20 +0,0 @@
-import { Column, Entity, JoinTable, ManyToMany } from 'typeorm';
-import { Permission } from './permission.entity';
-import { User } from './user.entity';
-import { BaseEntity } from './BaseEntity';
-
-@Entity({ name: 'roles' })
-export class Role extends BaseEntity {
-  @Column({ nullable: true })
-  name: string;
-
-  @ManyToMany(() => Permission, (permission) => permission.roles, {
-    onDelete: 'CASCADE',
-    eager: true
-  })
-  @JoinTable()
-  permissions: Permission[]
-
-  @ManyToMany(() => User, (user) => user.roles)
-  users: User[]
-}

package/entities/settings.entity.ts

@@ -1,56 +0,0 @@
-import { Column, Entity, JoinColumn, ManyToOne, OneToMany } from 'typeorm';
-import { PropertyMedia } from './property-media.entity';
-import { User } from './user.entity';
-import { AbstractBaseReviewableEntity } from './common.entity';
-import { Status } from '../types/common.type';
-
-@Entity({ name: 'settings' })
-export class Settings extends AbstractBaseReviewableEntity {
-  @ManyToOne(() => User, {
-    //eager: true,
-    onDelete: 'CASCADE',
-    onUpdate: 'CASCADE',
-  })
-  @JoinColumn({ name: 'created_by' })
-  creator: User;
-
-  @Column({ nullable: true })
-  createdBy: number;
-
-  @OneToMany(
-    () => PropertyMedia,
-    (PropertyMedia) => PropertyMedia.property,
-  )
-  media: PropertyMedia[];
-
-  @Column({ nullable: true })
-  title: string;
-
-  @Column()
-  location: string;
-
-  @Column()
-  startTime: Date;
-
-  @Column()
-  endTime: Date;
-
-  @Column({ default: true })
-  isPrivate: boolean;
-
-  @Column({ nullable: true })
-  qrOfflineCode: string;
-
-  @Column({
-    type: 'text',
-    nullable: true
-  })
-  description: string
-
-  @Column({
-    type: 'enum',
-    enum: Status,
-    default: Status.PENDING,
-  })
-  status: Status;
-}

package/entities/social.entity.ts

@@ -1,27 +0,0 @@
-import { Column, Entity, JoinColumn, ManyToOne } from 'typeorm';
-import { User } from './user.entity';
-import { AbstractBaseReviewableEntity } from './common.entity';
-
-@Entity({ name: 'social' })
-export class Social extends AbstractBaseReviewableEntity {
-  @ManyToOne(() => User, {
-    //eager: true,
-    onDelete: 'CASCADE',
-    onUpdate: 'CASCADE',
-  })
-  @JoinColumn({ name: 'user_id' })
-  user: User;
-
-  @Column({ nullable: true })
-  userId: number;
-
-  @Column({
-    nullable: true,
-  })
-  brand: string;
-
-  @Column({
-    nullable: true,
-  })
-  link: string;
-}

package/entities/tenant.entity.ts

@@ -1,65 +0,0 @@
-import { Entity, Column, Index, Unique } from 'typeorm';
-import { BaseEntity } from './BaseEntity';
-import { TenantStatus, TenantPlan } from '../types/tenant.enums';
-
-@Entity({ name: 'tenants' })
-@Unique(['subdomain'])
-@Unique(['domain'])
-export class Tenant extends BaseEntity {
-    @Column({ length: 255 })
-    name: string;
-
-    @Column({ length: 100, unique: true })
-    @Index()
-    subdomain: string; // e.g., 'acme' for acme.yourdomain.com
-
-    @Column({ length: 255, nullable: true, unique: true })
-    domain: string; // Optional custom domain: e.g., 'realestate.acme.com'
-
-    @Column({ type: 'varchar', default: TenantStatus.ACTIVE })
-    status: TenantStatus;
-
-    @Column({ type: 'varchar', default: TenantPlan.FREE })
-    plan: TenantPlan;
-
-    @Column({ type: 'json', nullable: true })
-    config: {
-        maxUsers?: number;
-        maxProperties?: number;
-        features?: string[];
-        customBranding?: {
-            logo?: string;
-            primaryColor?: string;
-            secondaryColor?: string;
-        };
-        [key: string]: any;
-    };
-
-    @Column({ type: 'json', nullable: true })
-    metadata: any; // Additional tenant-specific metadata
-
-    @Column({ type: 'timestamp', nullable: true })
-    trialEndsAt: Date;
-
-    @Column({ type: 'timestamp', nullable: true })
-    subscriptionEndsAt: Date;
-
-    // Contact information
-    @Column({ length: 255, nullable: true })
-    contactEmail: string;
-
-    @Column({ length: 50, nullable: true })
-    contactPhone: string;
-
-    // Database strategy (for future use if migrating to separate databases per tenant)
-    @Column({ type: 'varchar', default: 'shared' })
-    databaseStrategy: 'shared' | 'isolated';
-
-    @Column({ length: 255, nullable: true })
-    databaseHost: string;
-
-    @Column({ length: 100, nullable: true })
-    databaseName: string;
-}
-
-export default Tenant;