@bts-soft/core 1.0.4 → 1.2.5

package/README.md

@@ -1,116 +1,51 @@
 
-## @bts-soft/core | The BTS Software Core Toolkit
+# @bts-soft/core
 
-The **`@bts-soft/core`** package serves as the unified entry point for all high-quality, pre-configured modules developed by BTS Software.
-
-This package simplifies development by bundling essential backend components (like email queuing, security guards, and utilities) into one dependency, ensuring a consistent and robust NestJS architecture out-of-the-box.
+The **Core Package** is the main entry point of the **BTS Soft ecosystem**.  
+It bundles and re-exports all common utilities and modules used across different BTS packages, allowing developers to integrate them easily into any NestJS project.
 
 ---
 
-## Features and Included Modules
-
-By installing `@bts-soft/core`, you automatically gain access to all the following specialized modules and services:
-
-| Module          | NPM Package (Internal) | Description                                                                                    |
-| --------------- | ---------------------- | ---------------------------------------------------------------------------------------------- |
-| **Email Queue** | `@bts-soft/mail-queue` | Reliable, asynchronous email sending using BullMQ and Nodemailer, preventing request blocking. |
+##  Features
 
+- Centralized import for all BTS Soft modules  
+- Simplifies project setup and maintenance  
+- Works seamlessly with both REST and GraphQL environments  
 
 ---
 
-## Getting Started
-
-### 1. Installation
-
-Install the core package and its required peer dependencies (BullMQ, Nodemailer, etc. are installed automatically as dependencies of `@bts-soft/mail-queue`):
-
-
-```
-npm install @bts-soft/core
-```
-
-### 2. Configuration (Environment Variables)
+## Included Packages
 
-Your application must define the following environment variables (required primarily by the `mail-queue` module):
+- [@bts-soft/validation]([@bts-soft/validation - npm](https://www.npmjs.com/package/@bts-soft/validation)) — Input validation utilities & decorators  
+- [@bts-soft/upload]([@bts-soft/mail-queue - npm](https://www.npmjs.com/package/@bts-soft/upload)) — File upload middleware (GraphQL & REST)  
+- [@bts-soft/mail-queue]([@bts-soft/mail-queue - npm](https://www.npmjs.com/package/@bts-soft/mail-queue)) — Email queue handling with BullMQ  
+- [@bts-soft/config]([@bts-soft/mail-queue - npm](https://www.npmjs.com/package/@bts-soft/config)) — Environment & configuration management  
 
-|Variable|Usage|
-|---|---|
-|`REDIS_HOST`, `REDIS_PORT`|Required for BullMQ queue management.|
-|`MAIL_HOST`, `MAIL_USER`, `MAIL_PASS`|Required for Nodemailer SMTP connection.|
-
-### 3. Usage in `AppModule`
-
-All modules are designed to be imported directly from the `@bts-soft/core` package.
+---
 
+## Usage Example
 
-```
-// app.module.ts
+```ts
 import { Module } from '@nestjs/common';
-// Import all modules and services from the unified Core package
-import { EmailModule } from '@bts-soft/core'; 
+import { CoreModule } from '@bts-soft/core';
 
 @Module({
-  imports: [
-    // Example: Registering the Email Module
-    EmailModule.register({ 
-      // Optional: Custom connection settings can be passed here
-    }),
-    // ... Other application modules
-  ],
-  // ...
+  imports: [CoreModule],
 })
 export class AppModule {}
-```
-
-### 4. Injecting Services
+````
 
-Access services (like the email sender) by importing them directly from the core package:
-
-TypeScript
+---
 
-```
-// my.service.ts
-import { Injectable } from '@nestjs/common';
-import { SendEmailService } from '@bts-soft/core'; // Imported from @bts-soft/core
+## Learn More
 
-@Injectable()
-export class MyService {
-  constructor(private readonly emailService: SendEmailService) {}
+Visit each module’s documentation for details and advanced usage examples:
 
-  async handleSignup(user: any) {
-    // Logic...
+- [Validation Documentation]([@bts-soft/validation - npm](https://www.npmjs.com/package/@bts-soft/validation))
     
-    // Queue the email job
-    await this.emailService.sendEmail(
-      user.email, 
-      'Welcome!', 
-      'Thanks for signing up to our platform.'
-    );
-  }
-}
-```
-
-
-  
-
-## Contact
-
-  
-
-**Author:** Omar Sabry  
-
-**Email:** omar.sabry.dev@gmail.com  
-
-**LinkedIn:** [(1) Omar Sabry | LinkedIn](https://www.linkedin.com/in/omarsa6ry/)
-
-Portfolio: https://omarsabry.netlify.app/
-
-  
-
-  
-
-## Repository
-
-  
-
-**GitHub:** [bts-soft/packages/core at main · Omar-Sa6ry/bts-soft](https://github.com/Omar-Sa6ry/bts-soft/tree/main/packages/core)
+- [Upload Documentation]([@bts-soft/validation - npm](https://www.npmjs.com/package/@bts-soft/upload))
+    
+- [Mail Queue Documentation]([@bts-soft/mail-queue - npm](https://www.npmjs.com/package/@bts-soft/mail-queue))
+    
+- [Config Documentation]([@bts-soft/mail-queue - npm](https://www.npmjs.com/package/@bts-soft/mail-queue))
+    

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@bts-soft/core",
-  "version": "1.0.4",
+  "version": "1.2.5",
   "author": "Omar Sabry",
   "description": "All bts-soft packages",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
   "dependencies": {
-    "@bts-soft/mail-queue": "^1.0.5"
+    "@bts-soft/mail-queue": "^1.0.5",
+    "@bts-soft/upload": "^1.1.1",
+    "@bts-soft/validation":"^1.0.0"
   },
   "peerDependencies": {
     "@nestjs/common": "^10.0.0",

package/src/index.ts

@@ -1,4 +1,5 @@
-// packages/nestjs-core/src/index.ts
+// Mail Queue Module
+export * from '@bts-soft/mail-queue';
 
-// Mail Queue Module)
-export * from '@bts-soft/mail-queue';
+// Validation Decorators
+export * from '@bts-soft/validation';