@takentrade/takentrade-libs 4.1.8 → 4.1.9

package/README.md

@@ -1,6 +1,8 @@
 # TakeNTrade Microservices Libraries
 
-Shared libraries for the TakeNTrade microservices architecture, providing authentication, caching, messaging, notifications, and common utilities.
+Shared libraries for the TakeNTrade microservices architecture.
+
+This package provides shared authentication, caching, messaging, notification, and utility contracts used by the service repos.
 
 ## Installation
 
@@ -8,6 +10,16 @@ Shared libraries for the TakeNTrade microservices architecture, providing authen
 npm install @takentrade/takentrade-libs
 ```
 
+## Development
+
+```bash
+npm run build
+npm run test
+npm run typecheck
+npm run format
+npm run format:check
+```
+
 ## Quick Start
 
 ```typescript
@@ -38,108 +50,8 @@ For authentication, services can extend the shared `TntBaseAuthGuard` and pair i
 | ------------------ | ---------------------------------------------- | ---------------------------------------------- |
 | **Authentication** | Route protection and role-based access control | [docs/auth.md](docs/auth.md)                   |
 | **Cache**          | Redis-based caching with TTL support           | [docs/cache.md](docs/cache.md)                 |
-| **BullMQ**         | Background job processing and queues           | [docs/bullmq.md](docs/bullmq.md)               |
 | **NATS**           | Microservice messaging and event streaming     | [docs/nats.md](docs/nats.md)                   |
 | **Notifications**  | Email, SMS, and push notifications             | [docs/notifications.md](docs/notifications.md) |
 | **RPC**            | Request-response patterns for NATS             | [docs/rpc.md](docs/rpc.md)                     |
-| **Common**         | Shared constants, enums, and utilities         | [docs/common.md](docs/common.md)               |
+| **Common**         | Shared constants and utilities                 | [docs/common.md](docs/common.md)               |
 | **Utils**          | DTOs, pipes, filters, and helpers              | [docs/utils.md](docs/utils.md)                 |
-
-## Features
-
-### 🔐 Authentication & Authorization
-
-- `@Public()` and `@Roles()` decorators
-- `TntBaseAuthGuard` for shared JWT guard behavior
-- JWT-based authentication support
-- Role-based access control
-
-### 💾 Caching
-
-- Redis integration with ioredis
-- TTL support
-- Hash operations
-- Auto-reconnection
-
-### 🚀 Background Jobs
-
-- BullMQ integration
-- Job scheduling and retries
-- Delayed and repeatable jobs
-- Progress tracking
-
-### 📨 Messaging
-
-- NATS integration
-- Event patterns
-- Request-response (RPC)
-- Subject constants
-- Automatic logging
-
-### 📧 Notifications
-
-- Email (verification, OTP, password reset, etc.)
-- SMS notifications
-- Push notifications
-- Template support
-
-## Environment Variables
-
-```env
-# Cache & BullMQ
-REDIS_HOST=localhost
-REDIS_PORT=6379
-REDIS_PASSWORD=your_password
-
-# NATS
-NATS_URL=nats://localhost:4222
-NATS_SERVICE_QUEUE=service_queue
-
-# JWT
-JWT_SECRET=your_jwt_secret
-```
-
-## Usage Examples
-
-### Cache
-
-```typescript
-await this.cacheService.set('key', 'value', 3600); // 1 hour TTL
-const value = await this.cacheService.get('key');
-```
-
-### Background Jobs
-
-```typescript
-await this.queue.add(
-  'process-order',
-  { orderId: '123' },
-  {
-    attempts: 3,
-    backoff: { type: 'exponential', delay: 1000 },
-  }
-);
-```
-
-## Documentation
-
-- [Authentication](docs/auth.md) - Route protection and RBAC
-- [Cache](docs/cache.md) - Redis caching
-- [BullMQ](docs/bullmq.md) - Background jobs
-- [NATS](docs/nats.md) - Messaging
-- [Notifications](docs/notifications.md) - Email, SMS, push
-- [RPC](docs/rpc.md) - Request-response patterns
-- [Common](docs/common.md) - Shared utilities
-- [Utils](docs/utils.md) - DTOs, pipes, filters
-
-## Contributing
-
-This is a private package for TakeNTrade microservices.
-
-## License
-
-Proprietary - See [LICENSE](LICENSE) file for details.
-
-## Support
-
-For issues or questions, contact the TakeNTrade development team.

package/dist/common/index.d.ts

@@ -1,4 +1,2 @@
 export * from './constants';
-export * from './enums';
 export * from './utils';
-export * from './dto';

package/dist/common/index.js

@@ -15,6 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./constants"), exports);
-__exportStar(require("./enums"), exports);
 __exportStar(require("./utils"), exports);
-__exportStar(require("./dto"), exports);

package/dist/common/utils/index.d.ts

@@ -1,3 +1,2 @@
-export * from './string.utils';
 export * from './random.utils';
 export * from './reference.utils';

package/dist/common/utils/index.js

@@ -14,6 +14,5 @@ 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("./string.utils"), exports);
 __exportStar(require("./random.utils"), exports);
 __exportStar(require("./reference.utils"), exports);

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 export * from './nats';
 export * from './common';
-export * from './bullmq';
 export * from './cache';
 export * from './utils';
 export * from './rpc';

package/dist/index.js

@@ -16,7 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./nats"), exports);
 __exportStar(require("./common"), exports);
-__exportStar(require("./bullmq"), exports);
 __exportStar(require("./cache"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./rpc"), exports);

package/dist/nats/events/ajo.events.d.ts

@@ -0,0 +1,14 @@
+export interface AjoContributionEvent {
+    ajoId: string;
+    userId: string;
+    amount: number;
+    reference: string;
+    status: 'PENDING' | 'SUCCESSFUL' | 'FAILED' | 'REVERSED';
+    timestamp: string;
+}
+export interface AjoMemberJoinedEvent {
+    ajoId: string;
+    userId: string;
+    joinedAt: string;
+    timestamp: string;
+}

package/dist/nats/events/index.d.ts

@@ -1,174 +1,10 @@
-import { TransactionCategory, TransactionStatus } from '../../common/enums/transaction.enum';
-/**
- * NATS Event Contracts
- * TypeScript interfaces for inter-service communication via NATS
- */
-export interface UserCreatedEvent {
-    userId: string;
-    email: string;
-    phone: string;
-    username: string;
-    firstname?: string;
-    lastname?: string;
-    middlename?: string;
-    gender?: string;
-    dateOfBirth?: string;
-    referralCode?: string;
-    createdAt: string;
-}
-export interface PaymentSuccessEvent {
-    transactionId: string;
-    userId: string;
-    amount: number;
-    fee?: number;
-    currency: string;
-    category?: string;
-    provider: 'PROVIDUS' | 'PAYSTACK';
-    reference: string;
-    providerReference?: string;
-    balanceBefore?: number;
-    balanceAfter?: number;
-    metadata?: Record<string, any>;
-    timestamp: string;
-}
-export interface PaymentFailedEvent {
-    transactionId: string;
-    userId: string;
-    amount: number;
-    currency: string;
-    provider: 'PROVIDUS' | 'PAYSTACK';
-    reference: string;
-    reason: string;
-    errorCode?: string;
-    timestamp: string;
-}
-export interface TransactionProcessedEvent {
-    transactionId: string;
-    userId: string;
-    type: 'CREDIT' | 'DEBIT';
-    category: string;
-    amount: number;
-    fee: number;
-    balanceBefore: number;
-    balanceAfter: number;
-    reference: string;
-    description: string;
-    metadata?: Record<string, any>;
-    timestamp: string;
-}
-export interface NotificationSentEvent {
-    notificationId: string;
-    userId: string;
-    channel: 'EMAIL' | 'SMS' | 'PUSH' | 'VOICE';
-    type: string;
-    status: 'SENT' | 'FAILED';
-    timestamp: string;
-}
-export interface SavingsMaturedEvent {
-    savingsId: string;
-    userId: string;
-    amount: number;
-    interest: number;
-    interestRate?: number;
-    balance: number;
-    plan: string;
-    maturityDate: string;
-    timestamp: string;
-}
-export interface LoanApprovedEvent {
-    loanId: string;
-    userId: string;
-    amount: number;
-    interestRate: number;
-    totalInterest: number;
-    processingFee: number;
-    duration: string;
-    repaymentDate: string;
-    timestamp: string;
-}
-export interface LoanRepaidEvent {
-    loanId: string;
-    userId: string;
-    amount: number;
-    remainingBalance: number;
-    reference?: string;
-    timestamp: string;
-}
-export interface CreateProvidusAccountEvent {
-    userId: string;
-    bvn?: string;
-    firstName?: string;
-    lastName?: string;
-    dateOfBirth?: string;
-    phoneNumber?: string;
-    email?: string;
-    address?: string;
-}
-export interface KycVerifiedEvent {
-    userId: string;
-    verificationId: string;
-    bvn: string;
-    timestamp: string;
-}
-export interface KycRejectedEvent {
-    userId: string;
-    verificationId: string;
-    reason: string;
-    timestamp: string;
-}
-export interface VasTransactionEvent {
-    transactionId: string;
-    userId: string;
-    serviceId: string;
-    category: TransactionCategory;
-    amount: number;
-    recipientIdentifier: string;
-    status: TransactionStatus;
-    provider: string;
-    reference: string;
-    timestamp: string;
-}
-export interface AjoContributionEvent {
-    ajoId: string;
-    userId: string;
-    amount: number;
-    reference: string;
-    status: TransactionStatus;
-    timestamp: string;
-}
-export interface AjoMemberJoinedEvent {
-    ajoId: string;
-    userId: string;
-    joinedAt: string;
-    timestamp: string;
-}
-export interface ReferralRewardClaimedEvent {
-    userId: string;
-    referralId: string;
-    amount: number;
-    reference: string;
-    timestamp: string;
-}
-export interface WithdrawalRequestedEvent {
-    withdrawalId: string;
-    userId: string;
-    amount: number;
-    bankName: string;
-    accountNumber: string;
-    status: TransactionStatus;
-    timestamp: string;
-}
-export interface ProvidusDebitEvent {
-    userId: string;
-    amount: number;
-    reference: string;
-    metadata?: Record<string, any>;
-    timestamp: string;
-}
-export interface ProvidusCreditEvent {
-    userId: string;
-    amount: number;
-    reference: string;
-    metadata?: Record<string, any>;
-    timestamp: string;
-}
+export * from './user.events';
+export * from './payment.events';
+export * from './notification.events';
+export * from './savings.events';
+export * from './loans.events';
+export * from './vas.events';
+export * from './ajo.events';
+export * from './referral.events';
+export * from './withdrawal.events';
+export * from './providus.events';

package/dist/nats/events/index.js

@@ -1,2 +1,26 @@
 "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("./user.events"), exports);
+__exportStar(require("./payment.events"), exports);
+__exportStar(require("./notification.events"), exports);
+__exportStar(require("./savings.events"), exports);
+__exportStar(require("./loans.events"), exports);
+__exportStar(require("./vas.events"), exports);
+__exportStar(require("./ajo.events"), exports);
+__exportStar(require("./referral.events"), exports);
+__exportStar(require("./withdrawal.events"), exports);
+__exportStar(require("./providus.events"), exports);

package/dist/nats/events/loans.events.d.ts

@@ -0,0 +1,19 @@
+export interface LoanApprovedEvent {
+    loanId: string;
+    userId: string;
+    amount: number;
+    interestRate: number;
+    totalInterest: number;
+    processingFee: number;
+    duration: string;
+    repaymentDate: string;
+    timestamp: string;
+}
+export interface LoanRepaidEvent {
+    loanId: string;
+    userId: string;
+    amount: number;
+    remainingBalance: number;
+    reference?: string;
+    timestamp: string;
+}

package/dist/nats/events/loans.events.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/nats/events/notification.events.d.ts

@@ -0,0 +1,8 @@
+export interface NotificationSentEvent {
+    notificationId: string;
+    userId: string;
+    channel: 'EMAIL' | 'SMS' | 'PUSH' | 'VOICE';
+    type: string;
+    status: 'SENT' | 'FAILED';
+    timestamp: string;
+}

package/dist/nats/events/notification.events.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/nats/events/payment.events.d.ts

@@ -0,0 +1,40 @@
+export interface PaymentSuccessEvent {
+    transactionId: string;
+    userId: string;
+    amount: number;
+    fee?: number;
+    currency: string;
+    category?: string;
+    provider: 'PROVIDUS' | 'PAYSTACK';
+    reference: string;
+    providerReference?: string;
+    balanceBefore?: number;
+    balanceAfter?: number;
+    metadata?: Record<string, unknown>;
+    timestamp: string;
+}
+export interface PaymentFailedEvent {
+    transactionId: string;
+    userId: string;
+    amount: number;
+    currency: string;
+    provider: 'PROVIDUS' | 'PAYSTACK';
+    reference: string;
+    reason: string;
+    errorCode?: string;
+    timestamp: string;
+}
+export interface TransactionProcessedEvent {
+    transactionId: string;
+    userId: string;
+    type: 'CREDIT' | 'DEBIT';
+    category: string;
+    amount: number;
+    fee: number;
+    balanceBefore: number;
+    balanceAfter: number;
+    reference: string;
+    description: string;
+    metadata?: Record<string, unknown>;
+    timestamp: string;
+}

package/dist/nats/events/payment.events.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/nats/events/providus.events.d.ts

@@ -0,0 +1,14 @@
+export interface ProvidusDebitEvent {
+    userId: string;
+    amount: number;
+    reference: string;
+    metadata?: Record<string, unknown>;
+    timestamp: string;
+}
+export interface ProvidusCreditEvent {
+    userId: string;
+    amount: number;
+    reference: string;
+    metadata?: Record<string, unknown>;
+    timestamp: string;
+}

package/dist/nats/events/providus.events.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/nats/events/referral.events.d.ts

@@ -0,0 +1,7 @@
+export interface ReferralRewardClaimedEvent {
+    userId: string;
+    referralId: string;
+    amount: number;
+    reference: string;
+    timestamp: string;
+}

package/dist/nats/events/referral.events.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/nats/events/savings.events.d.ts

@@ -0,0 +1,11 @@
+export interface SavingsMaturedEvent {
+    savingsId: string;
+    userId: string;
+    amount: number;
+    interest: number;
+    interestRate?: number;
+    balance: number;
+    plan: string;
+    maturityDate: string;
+    timestamp: string;
+}

package/dist/nats/events/savings.events.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/nats/events/user.events.d.ts

@@ -0,0 +1,35 @@
+export interface UserCreatedEvent {
+    userId: string;
+    email: string;
+    phone: string;
+    username: string;
+    firstname?: string;
+    lastname?: string;
+    middlename?: string;
+    gender?: string;
+    dateOfBirth?: string;
+    referralCode?: string;
+    createdAt: string;
+}
+export interface CreateProvidusAccountEvent {
+    userId: string;
+    bvn?: string;
+    firstName?: string;
+    lastName?: string;
+    dateOfBirth?: string;
+    phoneNumber?: string;
+    email?: string;
+    address?: string;
+}
+export interface KycVerifiedEvent {
+    userId: string;
+    verificationId: string;
+    bvn: string;
+    timestamp: string;
+}
+export interface KycRejectedEvent {
+    userId: string;
+    verificationId: string;
+    reason: string;
+    timestamp: string;
+}

package/dist/nats/events/user.events.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/nats/events/vas.events.d.ts

@@ -0,0 +1,12 @@
+export interface VasTransactionEvent {
+    transactionId: string;
+    userId: string;
+    serviceId: string;
+    category: string;
+    amount: number;
+    recipientIdentifier: string;
+    status: 'PENDING' | 'SUCCESSFUL' | 'FAILED' | 'REVERSED';
+    provider: string;
+    reference: string;
+    timestamp: string;
+}

package/dist/nats/events/vas.events.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/nats/events/withdrawal.events.d.ts

@@ -0,0 +1,9 @@
+export interface WithdrawalRequestedEvent {
+    withdrawalId: string;
+    userId: string;
+    amount: number;
+    bankName: string;
+    accountNumber: string;
+    status: 'PENDING' | 'SUCCESSFUL' | 'FAILED' | 'REVERSED';
+    timestamp: string;
+}

package/dist/nats/events/withdrawal.events.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });