@valentine-efagene/qshelter-common 2.0.2 → 2.0.4

package/dist/{src/config → config}/config.service.d.ts

@@ -44,18 +44,62 @@ export declare class ConfigService {
     private readonly CACHE_TTL;
     private constructor();
     static getInstance(region?: string): ConfigService;
+    /**
+     * Get all infrastructure configuration from SSM Parameter Store
+     */
     getInfrastructureConfig(stage?: string): Promise<InfrastructureConfig>;
+    /**
+     * Get a single parameter from SSM
+     */
     getParameter(name: string): Promise<string>;
+    /**
+     * Get JWT secrets from Secrets Manager
+     */
     getJwtSecret(stage?: string): Promise<JwtSecrets>;
+    /**
+     * Get refresh token secret from Secrets Manager
+     */
     getRefreshTokenSecret(stage?: string): Promise<JwtSecrets>;
+    /**
+     * Get encryption secrets from Secrets Manager
+     */
     getEncryptionSecrets(stage?: string): Promise<EncryptionSecrets>;
+    /**
+     * Get OAuth secrets from Secrets Manager
+     */
     getOAuthSecrets(stage?: string): Promise<OAuthSecrets>;
+    /**
+     * Get Paystack secrets from Secrets Manager
+     */
     getPaystackSecrets(stage?: string): Promise<PaystackSecrets>;
+    /**
+     * Get Email secrets from Secrets Manager
+     */
     getEmailSecrets(stage?: string): Promise<EmailSecrets>;
+    /**
+     * Generic method to get any secret from Secrets Manager
+     */
     private getSecret;
+    /**
+     * Helper to extract parameter value from SSM response
+     */
     private getParamValue;
+    /**
+     * Get value from cache if valid
+     */
     private getFromCache;
+    /**
+     * Set value in cache with timestamp
+     */
     private setCache;
+    /**
+     * Clear the cache (useful for testing or forcing refresh)
+     */
     clearCache(): void;
+    /**
+     * Get a configuration value from environment variables
+     * This is useful for local development when AWS services are not available
+     */
+    get(key: string): string;
 }
 export declare const configService: ConfigService;

package/dist/{src/config → config}/config.service.js

@@ -1,15 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.configService = exports.ConfigService = void 0;
-const client_ssm_1 = require("@aws-sdk/client-ssm");
-const client_secrets_manager_1 = require("@aws-sdk/client-secrets-manager");
-class ConfigService {
+import { SSMClient, GetParameterCommand, GetParametersByPathCommand } from '@aws-sdk/client-ssm';
+import { SecretsManagerClient, GetSecretValueCommand } from '@aws-sdk/client-secrets-manager';
+export class ConfigService {
+    static instance;
+    ssmClient;
+    secretsClient;
+    cache = new Map();
+    cacheTimestamps = new Map();
+    CACHE_TTL = 5 * 60 * 1000; // 5 minutes
     constructor(region = 'us-east-1') {
-        this.cache = new Map();
-        this.cacheTimestamps = new Map();
-        this.CACHE_TTL = 5 * 60 * 1000;
-        this.ssmClient = new client_ssm_1.SSMClient({ region });
-        this.secretsClient = new client_secrets_manager_1.SecretsManagerClient({ region });
+        this.ssmClient = new SSMClient({ region });
+        this.secretsClient = new SecretsManagerClient({ region });
     }
     static getInstance(region) {
         if (!ConfigService.instance) {
@@ -17,6 +17,9 @@ class ConfigService {
         }
         return ConfigService.instance;
     }
+    /**
+     * Get all infrastructure configuration from SSM Parameter Store
+     */
     async getInfrastructureConfig(stage = process.env.NODE_ENV || 'dev') {
         const cacheKey = `infra-${stage}`;
         const cached = this.getFromCache(cacheKey);
@@ -24,7 +27,7 @@ class ConfigService {
             return cached;
         const pathPrefix = `/qshelter/${stage}/`;
         try {
-            const command = new client_ssm_1.GetParametersByPathCommand({
+            const command = new GetParametersByPathCommand({
                 Path: pathPrefix,
                 Recursive: true,
                 WithDecryption: false,
@@ -53,12 +56,15 @@ class ConfigService {
             throw new Error(`Failed to load infrastructure configuration: ${error.message}`);
         }
     }
+    /**
+     * Get a single parameter from SSM
+     */
     async getParameter(name) {
         const cached = this.getFromCache(name);
         if (cached)
             return cached;
         try {
-            const command = new client_ssm_1.GetParameterCommand({
+            const command = new GetParameterCommand({
                 Name: name,
                 WithDecryption: false,
             });
@@ -72,39 +78,62 @@ class ConfigService {
             throw new Error(`Failed to load parameter ${name}: ${error.message}`);
         }
     }
+    /**
+     * Get JWT secrets from Secrets Manager
+     */
     async getJwtSecret(stage = process.env.NODE_ENV || 'dev') {
         return this.getSecret(`qshelter/${stage}/jwt-secret`);
     }
+    /**
+     * Get refresh token secret from Secrets Manager
+     */
     async getRefreshTokenSecret(stage = process.env.NODE_ENV || 'dev') {
         return this.getSecret(`qshelter/${stage}/refresh-token-secret`);
     }
+    /**
+     * Get encryption secrets from Secrets Manager
+     */
     async getEncryptionSecrets(stage = process.env.NODE_ENV || 'dev') {
         return this.getSecret(`qshelter/${stage}/encryption`);
     }
+    /**
+     * Get OAuth secrets from Secrets Manager
+     */
     async getOAuthSecrets(stage = process.env.NODE_ENV || 'dev') {
         return this.getSecret(`qshelter/${stage}/oauth`);
     }
+    /**
+     * Get Paystack secrets from Secrets Manager
+     */
     async getPaystackSecrets(stage = process.env.NODE_ENV || 'dev') {
         return this.getSecret(`qshelter/${stage}/paystack`);
     }
+    /**
+     * Get Email secrets from Secrets Manager
+     */
     async getEmailSecrets(stage = process.env.NODE_ENV || 'dev') {
         return this.getSecret(`qshelter/${stage}/email`);
     }
+    /**
+     * Generic method to get any secret from Secrets Manager
+     */
     async getSecret(secretName) {
         const cached = this.getFromCache(secretName);
         if (cached)
             return cached;
         try {
-            const command = new client_secrets_manager_1.GetSecretValueCommand({
+            const command = new GetSecretValueCommand({
                 SecretId: secretName,
             });
             const response = await this.secretsClient.send(command);
             const secretString = response.SecretString || '{}';
+            // Try to parse as JSON first, if it fails treat as plain text
             let secret;
             try {
                 secret = JSON.parse(secretString);
             }
             catch {
+                // If not JSON, treat as plain text and wrap in object with 'secret' key
                 secret = { secret: secretString };
             }
             this.setCache(secretName, secret);
@@ -115,6 +144,9 @@ class ConfigService {
             throw new Error(`Failed to load secret ${secretName}: ${error.message}`);
         }
     }
+    /**
+     * Helper to extract parameter value from SSM response
+     */
     getParamValue(params, name) {
         const param = params.find(p => p.Name === name);
         if (!param) {
@@ -122,6 +154,9 @@ class ConfigService {
         }
         return param.Value || '';
     }
+    /**
+     * Get value from cache if valid
+     */
     getFromCache(key) {
         const now = Date.now();
         const cachedTime = this.cacheTimestamps.get(key);
@@ -130,15 +165,27 @@ class ConfigService {
         }
         return null;
     }
+    /**
+     * Set value in cache with timestamp
+     */
     setCache(key, value) {
         this.cache.set(key, value);
         this.cacheTimestamps.set(key, Date.now());
     }
+    /**
+     * Clear the cache (useful for testing or forcing refresh)
+     */
     clearCache() {
         this.cache.clear();
         this.cacheTimestamps.clear();
     }
+    /**
+     * Get a configuration value from environment variables
+     * This is useful for local development when AWS services are not available
+     */
+    get(key) {
+        return process.env[key] || '';
+    }
 }
-exports.ConfigService = ConfigService;
-exports.configService = ConfigService.getInstance();
-//# sourceMappingURL=config.service.js.map
+// Export singleton instance
+export const configService = ConfigService.getInstance();

package/dist/config/index.js

@@ -0,0 +1 @@
+export * from './config.service';

package/dist/index.d.ts

@@ -1,16 +1,3 @@
-export * from './pagination';
-export * from './standard-response';
-export * from './entities';
-export * from './middleware';
-export * from './helpers';
-export * from './decorator';
-export * from './types';
-export * from './guard';
-export * from './OpenApiHelper';
-export * from './encryption/encryption.service';
-export * from './encryption/encryption.module';
-export * from './qr-code/qr-code.service';
-export * from './qr-code/qr-code.module';
-export * from './qr-code/qr-code.type';
-export * from './qr-code/qr-code.dto';
-export * from './src/config';
+export * from './types/response';
+export * from './utils/errors';
+export * from './config';

package/dist/index.js

@@ -1,33 +1,3 @@
-"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("./pagination"), exports);
-__exportStar(require("./standard-response"), exports);
-__exportStar(require("./entities"), exports);
-__exportStar(require("./middleware"), exports);
-__exportStar(require("./helpers"), exports);
-__exportStar(require("./decorator"), exports);
-__exportStar(require("./types"), exports);
-__exportStar(require("./guard"), exports);
-__exportStar(require("./OpenApiHelper"), exports);
-__exportStar(require("./encryption/encryption.service"), exports);
-__exportStar(require("./encryption/encryption.module"), exports);
-__exportStar(require("./qr-code/qr-code.service"), exports);
-__exportStar(require("./qr-code/qr-code.module"), exports);
-__exportStar(require("./qr-code/qr-code.type"), exports);
-__exportStar(require("./qr-code/qr-code.dto"), exports);
-__exportStar(require("./src/config"), exports);
-//# sourceMappingURL=index.js.map
+export * from './types/response';
+export * from './utils/errors';
+export * from './config';

package/dist/types/prisma.d.ts

@@ -0,0 +1,2 @@
+export type { User, Role, Permission, RolePermission, Tenant, RefreshToken, PasswordReset, UserSuspension, EmailPreference, DeviceEndpoint, Social, Wallet, Transaction, Settings, Property, PropertyMedia, PropertyDocument, Amenity, PropertyAmenity, Mortgage, MortgageType, MortgageDocument, MortgageStep, MortgageDownpaymentPlan, MortgageDownpaymentInstallment, MortgageDownpaymentPayment, MortgageTransition, MortgageTransitionEvent, PaymentPlan, PaymentSchedule, PaymentInstallment, Payment, Contract, ContractDocument, Prisma, } from '@prisma/client';
+export { Prisma as PrismaNamespace } from '@prisma/client';

package/dist/types/prisma.js

@@ -0,0 +1,2 @@
+// Export Prisma namespace for advanced types
+export { Prisma as PrismaNamespace } from '@prisma/client';

package/dist/types/response.d.ts

@@ -0,0 +1,15 @@
+export interface ApiResponse<T = any> {
+    success: boolean;
+    data?: T;
+    error?: string;
+    message?: string;
+}
+export interface PaginatedResponse<T = any> {
+    data: T[];
+    total: number;
+    page: number;
+    pageSize: number;
+    totalPages: number;
+}
+export declare function successResponse<T>(data: T, message?: string): ApiResponse<T>;
+export declare function errorResponse(error: string): ApiResponse;

package/dist/types/response.js

@@ -0,0 +1,6 @@
+export function successResponse(data, message) {
+    return { success: true, data, message };
+}
+export function errorResponse(error) {
+    return { success: false, error };
+}

package/dist/utils/errors.d.ts

@@ -0,0 +1,21 @@
+export declare class AppError extends Error {
+    statusCode: number;
+    message: string;
+    isOperational: boolean;
+    constructor(statusCode: number, message: string, isOperational?: boolean);
+}
+export declare class ValidationError extends AppError {
+    constructor(message: string);
+}
+export declare class UnauthorizedError extends AppError {
+    constructor(message?: string);
+}
+export declare class ForbiddenError extends AppError {
+    constructor(message?: string);
+}
+export declare class NotFoundError extends AppError {
+    constructor(message?: string);
+}
+export declare class ConflictError extends AppError {
+    constructor(message: string);
+}

package/dist/utils/errors.js

@@ -0,0 +1,28 @@
+export class AppError extends Error {
+    statusCode;
+    message;
+    isOperational;
+    constructor(statusCode, message, isOperational = true) {
+        super(message);
+        this.statusCode = statusCode;
+        this.message = message;
+        this.isOperational = isOperational;
+        this.name = this.constructor.name;
+        Error.captureStackTrace(this, this.constructor);
+    }
+}
+export class ValidationError extends AppError {
+    constructor(message) { super(400, message); }
+}
+export class UnauthorizedError extends AppError {
+    constructor(message = 'Unauthorized') { super(401, message); }
+}
+export class ForbiddenError extends AppError {
+    constructor(message = 'Forbidden') { super(403, message); }
+}
+export class NotFoundError extends AppError {
+    constructor(message = 'Resource not found') { super(404, message); }
+}
+export class ConflictError extends AppError {
+    constructor(message) { super(409, message); }
+}

package/package.json

@@ -1,101 +1,36 @@
 {
-    "name": "@valentine-efagene/qshelter-common",
-    "version": "2.0.2",
-    "description": "Shared common utilities, DTOs, entities, guards, middleware, decorators, and pagination for QShelter",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "scripts": {
-        "build": "tsc",
-        "prepublishOnly": "npm run build",
-        "patch": "npm version patch && npm run build && npm publish --access public",
-        "publish:public": "npm publish --access public",
-        "build:watch": "tsc -w",
-        "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
-        "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix"
-    },
-    "keywords": [
-        "common",
-        "utilities",
-        "nestjs",
-        "entities",
-        "pagination",
-        "qshelter",
-        "aws",
-        "config"
-    ],
-    "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": {
-        "@nestjs/common": "^10.0.0",
-        "@nestjs/config": "^3.0.0",
-        "@nestjs/jwt": "^10.0.0",
-        "@nestjs/swagger": "^7.4.0",
-        "class-transformer": "^0.5.0",
-        "class-validator": "^0.14.0",
-        "typeorm": "^0.3.0"
-    },
-    "dependencies": {
-        "@aws-sdk/client-secrets-manager": "^3.958.0",
-        "@aws-sdk/client-ssm": "^3.958.0",
-        "@types/qrcode": "^1.5.6",
-        "handlebars": "^4.7.8",
-        "qrcode": "^1.5.4"
-    },
-    "devDependencies": {
-        "@nestjs/common": "^10.0.0",
-        "@nestjs/config": "^3.0.0",
-        "@nestjs/jwt": "^10.0.0",
-        "@nestjs/swagger": "^7.4.0",
-        "@types/handlebars": "^4.1.0",
-        "@types/node": "^20.0.0",
-        "class-transformer": "^0.5.1",
-        "class-validator": "^0.14.0",
-        "typeorm": "^0.3.20",
-        "typescript": "^5.0.0"
-    }
+  "name": "@valentine-efagene/qshelter-common",
+  "version": "2.0.4",
+  "description": "Shared database schemas and utilities for QShelter services",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "patch": "npm version patch && npm run build && npm publish --access public",
+    "prepublishOnly": "npm run build",
+    "publish:public": "npm publish --access public"
+  },
+  "keywords": [
+    "qshelter",
+    "common",
+    "schemas",
+    "prisma"
+  ],
+  "author": "Valentine Efagene",
+  "license": "MIT",
+  "files": [
+    "dist",
+    "prisma"
+  ],
+  "dependencies": {
+    "@prisma/client": "^7.0.0",
+    "prisma": "^7.0.0",
+    "@aws-sdk/client-ssm": "^3.500.0",
+    "@aws-sdk/client-secrets-manager": "^3.500.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.3"
+  }
 }