@valentine-efagene/qshelter-common 1.0.1 → 1.0.3

package/dist/types/tenant.type.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TenantPlan = exports.TenantStatus = void 0;
+var TenantStatus;
+(function (TenantStatus) {
+    TenantStatus["ACTIVE"] = "active";
+    TenantStatus["SUSPENDED"] = "suspended";
+    TenantStatus["PENDING"] = "pending";
+    TenantStatus["TRIAL"] = "trial";
+    TenantStatus["CANCELLED"] = "cancelled";
+})(TenantStatus || (exports.TenantStatus = TenantStatus = {}));
+var TenantPlan;
+(function (TenantPlan) {
+    TenantPlan["FREE"] = "free";
+    TenantPlan["BASIC"] = "basic";
+    TenantPlan["PREMIUM"] = "premium";
+    TenantPlan["ENTERPRISE"] = "enterprise";
+})(TenantPlan || (exports.TenantPlan = TenantPlan = {}));
+//# sourceMappingURL=tenant.type.js.map

package/dist/types/tenant.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenant.type.js","sourceRoot":"","sources":["../../types/tenant.type.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAMX;AAND,WAAY,YAAY;IACpB,iCAAiB,CAAA;IACjB,uCAAuB,CAAA;IACvB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,uCAAuB,CAAA;AAC3B,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AAED,IAAY,UAKX;AALD,WAAY,UAAU;IAClB,2BAAa,CAAA;IACb,6BAAe,CAAA;IACf,iCAAmB,CAAA;IACnB,uCAAyB,CAAA;AAC7B,CAAC,EALW,UAAU,0BAAV,UAAU,QAKrB"}

package/dist/types/user.type.d.ts

@@ -0,0 +1,10 @@
+export declare enum UserRole {
+    ADMIN = "admin",
+    VENDOR = "vendor",
+    USER = "user"
+}
+export declare enum UserStatus {
+    ACTIVE = "ACTIVE",
+    SUSPENDED = "SUSPENDED",
+    PENDING = "PENDING"
+}

package/dist/types/user.type.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserStatus = exports.UserRole = void 0;
+var UserRole;
+(function (UserRole) {
+    UserRole["ADMIN"] = "admin";
+    UserRole["VENDOR"] = "vendor";
+    UserRole["USER"] = "user";
+})(UserRole || (exports.UserRole = UserRole = {}));
+var UserStatus;
+(function (UserStatus) {
+    UserStatus["ACTIVE"] = "ACTIVE";
+    UserStatus["SUSPENDED"] = "SUSPENDED";
+    UserStatus["PENDING"] = "PENDING";
+})(UserStatus || (exports.UserStatus = UserStatus = {}));
+//# sourceMappingURL=user.type.js.map

package/dist/types/user.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.type.js","sourceRoot":"","sources":["../../types/user.type.ts"],"names":[],"mappings":";;;AAAA,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,6BAAiB,CAAA;IACjB,yBAAa,CAAA;AACf,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB;AAED,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,qCAAuB,CAAA;IACvB,iCAAmB,CAAA;AACrB,CAAC,EAJW,UAAU,0BAAV,UAAU,QAIrB"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@valentine-efagene/qshelter-common",
-    "version": "1.0.1",
+    "version": "1.0.3",
     "description": "Shared common utilities, DTOs, entities, guards, middleware, decorators, and pagination for QShelter",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -22,6 +22,51 @@
     ],
     "author": "Valentine Efagene",
     "license": "MIT",
+    "files": [
+        "dist"
+    ],
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "require": "./dist/index.js"
+        },
+        "./*": {
+            "import": "./dist/*",
+            "require": "./dist/*"
+        },
+        "./middleware/*": {
+            "import": "./dist/middleware/*",
+            "require": "./dist/middleware/*"
+        },
+        "./guard/*": {
+            "import": "./dist/guard/*",
+            "require": "./dist/guard/*"
+        },
+        "./helpers/*": {
+            "import": "./dist/helpers/*",
+            "require": "./dist/helpers/*"
+        },
+        "./decorator/*": {
+            "import": "./dist/decorator/*",
+            "require": "./dist/decorator/*"
+        },
+        "./entities/*": {
+            "import": "./dist/entities/*",
+            "require": "./dist/entities/*"
+        },
+        "./types/*": {
+            "import": "./dist/types/*",
+            "require": "./dist/types/*"
+        },
+        "./OpenApiHelper": {
+            "import": "./dist/OpenApiHelper.js",
+            "require": "./dist/OpenApiHelper.js"
+        },
+        "./standard-response": {
+            "import": "./dist/standard-response.js",
+            "require": "./dist/standard-response.js"
+        }
+    },
     "peerDependencies": {
         "typeorm": "^0.3.0",
         "@nestjs/common": "^10.0.0",
@@ -31,7 +76,9 @@
         "class-validator": "^0.14.0",
         "class-transformer": "^0.5.0"
     },
-    "dependencies": {},
+    "dependencies": {
+        "handlebars": "^4.7.8"
+    },
     "devDependencies": {
         "@nestjs/swagger": "^7.4.0",
         "typeorm": "^0.3.20",
@@ -41,6 +88,7 @@
         "class-validator": "^0.14.0",
         "class-transformer": "^0.5.1",
         "typescript": "^5.0.0",
-        "@types/node": "^20.0.0"
+        "@types/node": "^20.0.0",
+        "@types/handlebars": "^4.1.0"
     }
 }

package/OpenApiHelper.ts

@@ -1,121 +0,0 @@
-import { ApiHeaderOptions, ApiResponseOptions } from '@nestjs/swagger';
-
-export default class OpenApiHelper {
-  public static userIdHeader: ApiHeaderOptions = {
-    name: 'user_id',
-    description: "Requesting user's ID",
-    required: true,
-    example: '1',
-  };
-
-  public static responseDoc: ApiResponseOptions = {
-    status: 200,
-    description: 'Successful response',
-    schema: {
-      type: 'object',
-      properties: {
-        statusCode: { type: 'number' },
-        message: { type: 'string' },
-        data: { type: 'object' },
-      },
-    },
-  };
-
-  public static paginatedResponseDoc: ApiResponseOptions = {
-    status: 200,
-    description: 'Successful response',
-    schema: {
-      type: 'object',
-      properties: {
-        statusCode: { type: 'number' },
-        message: { type: 'string' },
-        data: {
-          type: 'object',
-          properties: {
-            data: { type: 'array', items: { type: 'object' } }, // Adjust the type based on your actual item type
-            meta: {
-              type: 'object',
-              properties: {
-                itemsPerPage: { type: 'number' },
-                totalItems: { type: 'number' },
-                currentPage: { type: 'number' },
-                totalPages: { type: 'number' },
-                sortBy: { type: 'array' },
-                search: { type: 'string' },
-                filter: {
-                  type: 'object',
-                },
-              },
-            },
-            link: {
-              type: 'object',
-              properties: {
-                first: { type: 'string' },
-                previous: { type: 'string' },
-                current: { type: 'string' },
-                next: { type: 'string' },
-                last: { type: 'string' },
-              },
-            },
-          },
-        },
-      },
-    },
-  };
-
-  public static arrayResponseDoc: ApiResponseOptions = {
-    status: 200,
-    description: 'Successful response',
-    schema: {
-      type: 'object',
-      properties: {
-        statusCode: { type: 'number' },
-        message: { type: 'string' },
-        data: {
-          type: 'array',
-          items: { type: 'object' },
-        },
-      },
-    },
-  };
-
-  public static nullResponseDoc: ApiResponseOptions = {
-    status: 200,
-    description: 'Successful response',
-    schema: {
-      oneOf: [
-        {
-          type: 'object',
-          properties: {
-            statusCode: { type: 'number' },
-            message: { type: 'string' },
-            data: {
-              type: 'string',
-              nullable: true,
-              description: 'Nothing is returned',
-            },
-          },
-        },
-      ],
-    },
-  };
-
-  public static errorResponseDoc: ApiResponseOptions = {
-    status: 200,
-    description: 'Successful response',
-    schema: {
-      oneOf: [
-        {
-          type: 'object',
-          properties: {
-            statusCode: { type: 'number' },
-            message: { type: 'string' },
-            error: {
-              type: 'object',
-            },
-          },
-        },
-      ],
-    },
-  };
-}

package/decorator/permission.decorator.ts

@@ -1,4 +0,0 @@
-import { Reflector } from '@nestjs/core';
-import { PermissionName } from '../../permission/permission.enums';
-
-export const RequirePermission = Reflector.createDecorator<PermissionName>();

package/decorator/tenant.decorator.ts

@@ -1,16 +0,0 @@
-import { createParamDecorator, ExecutionContext } from '@nestjs/common';
-import { Tenant } from '../../tenant/tenant.entity';
-
-export const CurrentTenant = createParamDecorator(
-    (data: unknown, ctx: ExecutionContext): Tenant | undefined => {
-        const request = ctx.switchToHttp().getRequest();
-        return request.tenant;
-    },
-);
-
-export const CurrentTenantId = createParamDecorator(
-    (data: unknown, ctx: ExecutionContext): number | undefined => {
-        const request = ctx.switchToHttp().getRequest();
-        return request.tenantId;
-    },
-);

package/entities/BaseEntity.ts

@@ -1,34 +0,0 @@
-import Tenant from './tenant.entity';
-import { CreateDateColumn, DeleteDateColumn, PrimaryGeneratedColumn, UpdateDateColumn, Column, Index, ManyToOne, JoinColumn } from 'typeorm';
-
-export class BaseEntity {
-  @PrimaryGeneratedColumn()
-  id: number;
-
-  @CreateDateColumn({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
-  createdAt: Date;
-
-  @UpdateDateColumn({
-    type: 'timestamp',
-    default: () => 'CURRENT_TIMESTAMP',
-    onUpdate: 'CURRENT_TIMESTAMP',
-  })
-  updatedAt: Date;
-
-  @DeleteDateColumn({ nullable: true, default: null })
-  deletedAt: Date;
-}
-
-/**
- * Tenant-aware version of BaseEntity
- * Use this for entities that need tenant isolation
- */
-export class TenantAwareBaseEntity extends BaseEntity {
-  @ManyToOne(() => Tenant, { onDelete: 'CASCADE' })
-  @JoinColumn({ name: 'tenant_id' })
-  tenant: Tenant;
-
-  @Column({ name: 'tenant_id' })
-  @Index()
-  tenantId: number;
-}

package/entities/TenantAwareEntity.ts

@@ -1,34 +0,0 @@
-import Tenant from './tenant.entity';
-import { CreateDateColumn, DeleteDateColumn, PrimaryGeneratedColumn, UpdateDateColumn, Column, Index, ManyToOne, JoinColumn } from 'typeorm';
-
-/**
- * Base entity with tenant support
- * All entities that need to be isolated by tenant should extend this
- */
-export class TenantAwareEntity {
-    @PrimaryGeneratedColumn()
-    id: number;
-
-    @ManyToOne(() => Tenant, { onDelete: 'CASCADE' })
-    @JoinColumn({ name: 'tenant_id' })
-    tenant: Tenant;
-
-    @Column({ name: 'tenant_id' })
-    @Index()
-    tenantId: number;
-
-    @CreateDateColumn({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
-    createdAt: Date;
-
-    @UpdateDateColumn({
-        type: 'timestamp',
-        default: () => 'CURRENT_TIMESTAMP',
-        onUpdate: 'CURRENT_TIMESTAMP',
-    })
-    updatedAt: Date;
-
-    @DeleteDateColumn({ nullable: true, default: null })
-    deletedAt: Date;
-}
-
-export default TenantAwareEntity;

package/entities/TenantAwareRepository.ts

@@ -1,100 +0,0 @@
-import { Repository, FindManyOptions, FindOneOptions, FindOptionsWhere, DeepPartial } from 'typeorm';
-
-/**
- * Base repository with automatic tenant scoping
- * All queries automatically filter by tenantId
- */
-export class TenantAwareRepository<Entity extends { tenantId: number }> extends Repository<Entity> {
-    /**
-     * Find entities with automatic tenant filtering
-     */
-    async findByTenant(tenantId: number, options?: FindManyOptions<Entity>): Promise<Entity[]> {
-        return this.find({
-            ...options,
-            where: {
-                ...options?.where,
-                tenantId,
-            } as FindOptionsWhere<Entity>,
-        });
-    }
-
-    /**
-     * Find one entity with automatic tenant filtering
-     */
-    async findOneByTenant(
-        tenantId: number,
-        options?: FindOneOptions<Entity>
-    ): Promise<Entity | null> {
-        return this.findOne({
-            ...options,
-            where: {
-                ...options?.where,
-                tenantId,
-            } as FindOptionsWhere<Entity>,
-        });
-    }
-
-    /**
-     * Count entities with automatic tenant filtering
-     */
-    async countByTenant(tenantId: number, options?: FindManyOptions<Entity>): Promise<number> {
-        return this.count({
-            ...options,
-            where: {
-                ...options?.where,
-                tenantId,
-            } as FindOptionsWhere<Entity>,
-        });
-    }
-
-    /**
-     * Create and save entity with automatic tenantId
-     */
-    async createForTenant(tenantId: number, entityData: DeepPartial<Entity>): Promise<Entity> {
-        const entity = this.create({
-            ...entityData,
-            tenantId,
-        } as DeepPartial<Entity>);
-        return this.save(entity);
-    }
-
-    /**
-     * Update entity with tenant validation
-     */
-    async updateForTenant(
-        tenantId: number,
-        id: number,
-        entityData: DeepPartial<Entity>
-    ): Promise<Entity> {
-        const entity = await this.findOneByTenant(tenantId, { where: { id } as any });
-        if (!entity) {
-            throw new Error(`Entity with ID ${id} not found for tenant ${tenantId}`);
-        }
-        Object.assign(entity, entityData);
-        return this.save(entity);
-    }
-
-    /**
-     * Delete entity with tenant validation
-     */
-    async deleteForTenant(tenantId: number, id: number): Promise<void> {
-        const entity = await this.findOneByTenant(tenantId, { where: { id } as any });
-        if (!entity) {
-            throw new Error(`Entity with ID ${id} not found for tenant ${tenantId}`);
-        }
-        await this.remove(entity);
-    }
-
-    /**
-     * Soft delete entity with tenant validation
-     */
-    async softDeleteForTenant(tenantId: number, id: number): Promise<void> {
-        const entity = await this.findOneByTenant(tenantId, { where: { id } as any });
-        if (!entity) {
-            throw new Error(`Entity with ID ${id} not found for tenant ${tenantId}`);
-        }
-        await this.softRemove(entity);
-    }
-}
-
-export default TenantAwareRepository;

package/entities/amenity.entity.ts

@@ -1,10 +0,0 @@
-import { Column, Entity } from 'typeorm';
-import { BaseEntity } from './BaseEntity';
-
-@Entity({ name: 'amenity' })
-export class Amenity extends BaseEntity {
-  @Column({
-    nullable: false
-  })
-  name: string
-}

package/entities/common.entity.ts

@@ -1,46 +0,0 @@
-import { User } from './user.entity';
-import {
-  ManyToOne,
-  JoinColumn,
-  Column,
-} from 'typeorm';
-import { DocumentStatus } from '../types/common.type';
-import { AbstractTenantAwareEntity } from './common.pure.entity';
-
-export abstract class AbstractBaseReviewableEntity extends AbstractTenantAwareEntity {
-  @ManyToOne(() => User, { eager: true })
-  @JoinColumn({ name: 'reviewed_by' })
-  reviewer: User;
-
-  @Column({ type: 'timestamp', nullable: true })
-  reviewedAt: string;
-}
-
-export abstract class AbstractBaseDocumentEntity extends AbstractBaseReviewableEntity {
-  @Column({
-    type: 'enum',
-    enum: DocumentStatus,
-    default: DocumentStatus.PENDING,
-  })
-  status: DocumentStatus;
-
-  @Column({ nullable: true })
-  comment: string;
-
-  @Column({ type: 'text', nullable: false })
-  url: string;
-
-  @Column({ nullable: true })
-  description: string;
-
-  @Column({ nullable: true })
-  name: string;
-
-  @Column({ nullable: false, comment: "In bytes" })
-  size: number
-}
-
-export abstract class AbstractBaseMediaEntity extends AbstractBaseDocumentEntity {
-  // @Column()
-  // mimeType: string;
-}

package/entities/common.pure.entity.ts

@@ -1,36 +0,0 @@
-
-import { CreateDateColumn, DeleteDateColumn, PrimaryGeneratedColumn, UpdateDateColumn, Column, Index, ManyToOne, JoinColumn } from "typeorm";
-import { Tenant } from "./tenant.entity";
-
-
-export abstract class AbstractBaseEntity {
-    @PrimaryGeneratedColumn()
-    id: number;
-
-    @CreateDateColumn({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
-    createdAt: Date;
-
-    @UpdateDateColumn({
-        type: 'timestamp',
-        default: () => 'CURRENT_TIMESTAMP',
-        onUpdate: 'CURRENT_TIMESTAMP',
-    })
-    updatedAt: Date;
-
-    @DeleteDateColumn({ nullable: true, default: null })
-    deletedAt: Date;
-}
-
-/**
- * Tenant-aware base entity
- * All entities that need tenant isolation should extend this
- */
-export abstract class AbstractTenantAwareEntity extends AbstractBaseEntity {
-    @ManyToOne(() => Tenant, { onDelete: 'CASCADE' })
-    @JoinColumn({ name: 'tenant_id' })
-    tenant: Tenant;
-
-    @Column({ name: 'tenant_id' })
-    @Index()
-    tenantId: number;
-}

package/entities/index.ts

@@ -1,27 +0,0 @@
-export * from './BaseEntity';
-export * from './TenantAwareEntity';
-export * from './TenantAwareRepository';
-export * from './amenity.entity';
-export * from './common.entity';
-export * from './common.pure.entity';
-export * from './mortgage-document.entity';
-export * from './mortgage-downpayment-installment.entity';
-export * from './mortgage-downpayment-payment.entity';
-export * from './mortgage-downpayment.entity';
-export * from './mortgage-step.entity';
-export * from './mortgage-type.entity';
-export * from './mortgage.entity';
-export * from './password_reset_tokens.entity';
-export * from './permission.entity';
-export * from './property-document.entity';
-export * from './property-media.entity';
-export * from './property.entity';
-export * from './refresh_token.entity';
-export * from './role.entity';
-export * from './settings.entity';
-export * from './social.entity';
-export * from './tenant.entity';
-export * from './transaction.entity';
-export * from './user.entity';
-export * from './user_suspensions.entity';
-export * from './wallet.entity';

package/entities/mortgage-document.entity.ts

@@ -1,37 +0,0 @@
-import { Column, Entity, JoinColumn, ManyToOne } from 'typeorm';
-import { AbstractBaseReviewableEntity } from './common.entity';
-import { Mortgage } from './mortgage.entity';
-import { User } from './user.entity';
-
-@Entity({ name: 'mortgage_document' })
-export class MortgageDocument extends AbstractBaseReviewableEntity {
-    @ManyToOne(() => Mortgage, (mortgage) => mortgage.documents, { onDelete: 'CASCADE' })
-    @JoinColumn({ name: 'mortgage_id' })
-    mortgage: Mortgage;
-
-    @Column({ nullable: true })
-    mortgageId: number;
-
-    @Column()
-    fileName: string;
-
-    // Allow null URLs for template/placeholder documents created from mortgage type templates.
-    @Column({ nullable: true })
-    url: string;
-
-    // Flag to mark this document as a template/placeholder (not yet uploaded). Template docs typically have a name but no URL.
-    @Column({ default: false })
-    isTemplate: boolean;
-
-    @Column({ nullable: true })
-    mimeType: string;
-
-    @ManyToOne(() => User, { nullable: true })
-    @JoinColumn({ name: 'uploaded_by' })
-    uploadedBy: User;
-
-    @Column({ nullable: true })
-    uploadedById: number;
-}
-
-export default MortgageDocument;

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

@@ -1,40 +0,0 @@
-import { Column, Entity, JoinColumn, ManyToOne } from 'typeorm';
-import { AbstractBaseEntity } from './common.pure.entity';
-import { MortgageDownpaymentPlan } from './mortgage-downpayment.entity';
-
-export enum InstallmentStatus {
-    PENDING = 'PENDING',
-    PARTIAL = 'PARTIAL',
-    PAID = 'PAID',
-    LATE = 'LATE',
-}
-
-@Entity({ name: 'mortgage_downpayment_installment' })
-export class MortgageDownpaymentInstallment extends AbstractBaseEntity {
-    @ManyToOne(() => MortgageDownpaymentPlan, (p) => p.installments, { onDelete: 'CASCADE' })
-    @JoinColumn({ name: 'plan_id' })
-    plan: MortgageDownpaymentPlan;
-
-    @Column({ nullable: true })
-    planId: number;
-
-    @Column({ type: 'int' })
-    sequence: number;
-
-    @Column({ type: 'date' })
-    dueDate: Date;
-
-    @Column({ type: 'double precision' })
-    amountDue: number;
-
-    @Column({ type: 'double precision', default: 0 })
-    amountPaid: number;
-
-    @Column({ type: 'timestamp', nullable: true })
-    paidAt: Date;
-
-    @Column({ type: 'enum', enum: InstallmentStatus, default: InstallmentStatus.PENDING })
-    status: InstallmentStatus;
-}
-
-export default MortgageDownpaymentInstallment;