arkos 0.0.22 → 0.1.0-beta.1

package/README.md

@@ -1,199 +1,199 @@
-![Header Image](https://lh3.googleusercontent.com/fife/ALs6j_FI9nS50W4dcqqGJhLerYqqQEQwEGzDFpgm9jvfg4zFzOxdMmBt4jXnQ02DXtqbSmeBQOx_cgDwUUluVCmnX4Yd5oxeNsZSBZ-xNZTm1VocSsJKc6OXGZXGKZ9wvxvaW1XdSKuxCtbsvI5Tuuu1l5sfXGmkxpo3l3FnS6BBOMqBjhQefSLR72NU6_QNpNpY9zPMepHBjRZ6R3VyES8oJw_P6lbJzKJu5ENZ-Z6I__0tuFpSed78fWWGI7mjoMhr9vM08jn66pYl9mGucQvV2_46CCCXtaRp7PskIx8fljmEjsYVhwr2Mmaa_wr_5YBaS8L72ah5C_5pLwvhXuez9hZI8JR8oEA2GKNwxCEnA66B8j6gBm0WsIkR3mJCZTTK8L4iR23SC8Z2JKoK3DehJ2lOxzwQs59jMTOk3uMb0Z_nBYqi2qUxYtN1wb5HRtO9POmfBJr42ZDnLhgHCy6ULus9KJYztDb3yBERi7zS6JIcxcGfW0B2VHQLiTDM--gOmuRNfdjeZREnvj3CrQh1DtfcF6rJ4uPx_ITrsb-yN88A4NHVjIct2ge1avxnfFFszi_vqFKYn5UCql2PM-1lOmWK3tLOjnzpQpBvO8Zny9phV5glHlrZLKPzklN7XE64qD-qFY9akLdukJjxMF56KTVfT3c06RLNhVDmaHaAZPJ3ESmojPAjvVrN4mdqmp1rjOG3HIa1z2Y-UUthzPCjY0XdMJFzPjoXSFV73rt9gpUPehXPMNNgL161cG7Kf_YW6XU5yBkKcbh4QojNe32bJQVPSnvD_GlkpVhefHqq3N54W8-pajIHfoHbboaGs129yju22UQ9zZI1HY1oQP7sVlzJsYCXTLN9kJSnLpzmIcIbai2jFHtD5icsKLLx0RHJJZPe5Uw0cBLnFEN9udEXSur9vuIg0saMT-b_Uc5A-B2ZMZngXCWC3ObC4NRArnSRiauoEKWuMOwpPsXunrCtPn5LOKtE2PoU7fbmXkTbuWCsmoKrBZIuakRzrLig7NrtRIM8DfbvItFGIxEG2kJTpkyzQI4HzVGLRKJX6AiwTBqh-L67iciYrVGhUSzM4p1E4iN-16z_KqnhSU-6GgXA_l-FPLd9wDfRt0BKl9mmFz5iif44aKflCWS449bZh12SEJeAhCwu442E2Ldc4kiwn29r7AdH09fVx7st9WWMbhhcGfhbNEY9rvjrLKx_gamfZdnXI0nof3rqb-U5hLjYY2wUW5XTE2vHquX5JYHsUD_iYEPUOhdPzowKsKDqRTn2v9fLJe9lDutfm7Ywvax_W8oosxNT9jTbSAXnMuia3Lqr8UZwVNyJRm50VPDbtYriYv7p6YbbuV_HwTk29oskRoRVAcPB0U2nuNiJ1hWChzeGCa9XNcfThEr3BEo2b1jNcl-WOcLnRN2p3XzMe4ltGNECME31k8MmFTe64UeeidJtGAu9TCi1GOo7NQeD_62Jhn0OgByExoJ0WTf9J5HXhwSJo5wVk7Ua8tl6yO7X-LUeqI4EMNbYtdCVAUTyE4ij8OxYcvx8ciV4UNZJmu35tlRDnKsYCbSUSQMkDeGBND00sAAovkrMzmgKhvFdfTDJOwtj1so1sDVS_ZC1AXzAog=w2688-h1984)
-
-### **What is Arkos**
-
-**Arkos** is a **lightweight backend framework** for **Express.js and Prisma** that simplifies API development by providing automatic route generation, built-in authentication, error handling, and file upload optimization. Designed to be a foundational layer for backend applications, Arkos allows developers to quickly set up a secure and scalable server with minimal configuration.
-
----
-
-### **Key Features**
-
-- 🚀 **Automatic API Generation** – Instantly create RESTful API routes for Prisma models.
-
-- 🔐 **Built-in Authentication** – Supports JWT-based authentication with effortless setup.
-
-- ⚡ **Express Middlewares** – Pre-configured security, request parsing, and error handling.
-
-- 🛡️ **Built-in Data Validation** – using class-validator and class-transformer, just drop a create-post.dto.ts.
-
-- ⬆️ **File Upload & Optimization** – Efficient image, video, docs, raw-file handling.
-
-- 💠 **Prisma Integration** – Seamless connection with Prisma ORM for database management with relation feilds handling.
-
-- 👨‍💻 **Interceptors Middlewares** – Tailor as you want, intercept, customize, for example using beforeCreateOne, afterSignUp.
-
-- ✉️ **Nodemailer Integration** – Seamless nodemailer integration for sending emails.
-
-With Arkos, developers can **bootstrap their backend in seconds**, focusing on building features rather than repetitive setup tasks.
-
-### 1. **Install the Package**
-
-Before running the code, make sure your package (`arkos`) is installed in your project. You can do this by running:
-
-```bash
-npm install arkos
-```
-
-or if you are using `pnpm`:
-
-```bash
-pnpm install arkos
-```
-
-### 2. **Setup Prisma Client**
-
-Here's how Prisma should be set up to use seamlessly with arkos:
-
-1. **Install Prisma and initialize it:**
-   Make sure you have Prisma installed in your project. You can install it using:
-
-   ```bash
-   npm install @prisma/client
-   npm install prisma --save-dev
-   ```
-
-2. **Set up your Prisma schema:**
-   You should have your `prisma/schema.prisma` file properly configured and migrate the database with Prisma commands:
-
-   ```bash
-   npx prisma generate
-   npx prisma migrate dev
-   ```
-
-3. **Initialize Prisma client:**
-   You'll need to have the `prisma` client initialized in your `src/utils/prisma.ts` file. For example:
-
-   ```typescript
-   // src/utils/prisma.ts
-   import { PrismaClient } from "@prisma/client";
-
-   export const prisma = new PrismaClient();
-   ```
-
-### 3. **Using `init` from `arkos`**
-
-The `init` function from your `arkos` package is used to initialize the app with required configurations. Here's how you can structure it:
-
-```typescript
-// src/app.ts
-import arkos from "arkos"; // Import arkos.init() from arkos package
-import express from "express"; // Import express
-
-// Initialize the Express app
-const app = express();
-
-// Call init and pass the Express app for configuration, app will listen in 8000 by default or set PORT in .env.developement or .env.production
-arkos.init(app);
-```
-
-### 4. **How `arkos.init()` Works:**
-
-- **Initialization**: The `arkos.init()` function is called with two arguments, the second being optional:
-  - `app`: The Express application instance.
-  - `options`: An object containing configurations for toggle `authentication` and pass the desired `port`.
-- **What happens under the hood**:
-  - **Authentication Setup**: The package will set (read further to learn how to prepare the environment) up authentication routes, middleware, and necessary handlers for managing user sessions and JWT tokens.
-  - **Error Handling**: Automatic error handling middleware could be added.
-  - **File Upload**: Arkos will configure necessary middleware to handle file uploads, image upload optimization, and route generation.
-  - **Prisma Integration**: The prisma instance must be export as default or as prisma under scr/utils/prisma.ts.
-
-### 5. **Additional Configuration (Optional)**
-
-You can customize additional settings such as routes for file uploads, email handling, and more, based on what your `arkos` package offers. The `arkos.init()` function may have additional configuration options, depending on how flexible and customizable the package is.
-
----
-
-### Example Directory Structure
-
-Here is how the directory structure might look for this project:
-
-```
-project-root/
-│
-├── node_modules/
-│
-├── src/
-│   ├── utils/
-│   │   └── prisma.ts          # Prisma client initialization
-│   ├── app.ts                 # Express app setup with arkos.init()
-│
-├── package.json               # Your project dependencies
-└── prisma/
-    └── schema/
-        └── schema.prisma          # Your Prisma schema file
-        └── post.prisma          # Your Post model file
-```
-
----
-
-### Example of `prisma/schema.prisma`:
-
-Ensure you have a basic Prisma schema like this:
-
-```typescript
-// prisma/schema.prisma
-datasource db {
-  provider = "sqlite" // Replace with your database provider (e.g., 'mongodb', 'mysql', 'sqlite', 'postgresql')
-  url      = env("DATABASE_URL")
-}
-
-generator client {
-  provider        = "prisma-client-js"
-  previewFeatures = ["prismaSchemaFolder"]
-}
-
-model Post {
-  id       Int     @id @default(autoincrement())
-  title    String  @unique
-  content String
-  createdAt DateTime @default(now())
-}
-```
-
-Run the following to generate the Prisma client:
-
-```bash
-npx prisma generate
-```
-
-After all there will be routes for
-
-- Find many, GET: /api/posts
-- Find one, GET: /api/posts/:id
-- Create one POST: /api/posts
-- Update one, PATCH: /api/posts/:id
-- Delete one, DELETE: /api/posts/:id
-
----
-
-### Recap
-
-- You need `prisma` properly set up.
-- Once `arkos.init()` is invoked with your `express` app the package will handle routing, authentication, file uploads, etc., automatically.
-- Ensure you have all dependencies installed (`arkos`, `prisma`, `express`, etc.) before running the app.
-
----
-
-## 📝 License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
----
-
-## 📫 Contact
-
-For any issues or questions, please open an issue or contact [Uanela Como](mailto:uanelaluiswayne@gmail.com).
-
-Feel free to reach out for questions, suggestions, or contributions ❤️.
-
----
-
-### **Origin of the Name "Arkos"**
-
-The name **"Arkos"** is derived from the Greek word **ἀρχή (Arkhē)**, which means **"beginning"** or **"foundation"**. This interpretation perfectly aligns with the core purpose of the package — to serve as a **foundational layer** for quickly setting up backend systems. Just as **ἀρχή** represents the starting point or origin, Arkos is designed to **initiate** and **structure** backend projects, providing developers with a robust base to build upon.
-
-This makes Arkos an essential tool for **bootstrapping** and organizing backend applications, helping developers focus on features rather than repetitive setup tasks.
-
----
-
-### NB: More documentation coming soon
+![Header Image](https://lh3.googleusercontent.com/fife/ALs6j_FI9nS50W4dcqqGJhLerYqqQEQwEGzDFpgm9jvfg4zFzOxdMmBt4jXnQ02DXtqbSmeBQOx_cgDwUUluVCmnX4Yd5oxeNsZSBZ-xNZTm1VocSsJKc6OXGZXGKZ9wvxvaW1XdSKuxCtbsvI5Tuuu1l5sfXGmkxpo3l3FnS6BBOMqBjhQefSLR72NU6_QNpNpY9zPMepHBjRZ6R3VyES8oJw_P6lbJzKJu5ENZ-Z6I__0tuFpSed78fWWGI7mjoMhr9vM08jn66pYl9mGucQvV2_46CCCXtaRp7PskIx8fljmEjsYVhwr2Mmaa_wr_5YBaS8L72ah5C_5pLwvhXuez9hZI8JR8oEA2GKNwxCEnA66B8j6gBm0WsIkR3mJCZTTK8L4iR23SC8Z2JKoK3DehJ2lOxzwQs59jMTOk3uMb0Z_nBYqi2qUxYtN1wb5HRtO9POmfBJr42ZDnLhgHCy6ULus9KJYztDb3yBERi7zS6JIcxcGfW0B2VHQLiTDM--gOmuRNfdjeZREnvj3CrQh1DtfcF6rJ4uPx_ITrsb-yN88A4NHVjIct2ge1avxnfFFszi_vqFKYn5UCql2PM-1lOmWK3tLOjnzpQpBvO8Zny9phV5glHlrZLKPzklN7XE64qD-qFY9akLdukJjxMF56KTVfT3c06RLNhVDmaHaAZPJ3ESmojPAjvVrN4mdqmp1rjOG3HIa1z2Y-UUthzPCjY0XdMJFzPjoXSFV73rt9gpUPehXPMNNgL161cG7Kf_YW6XU5yBkKcbh4QojNe32bJQVPSnvD_GlkpVhefHqq3N54W8-pajIHfoHbboaGs129yju22UQ9zZI1HY1oQP7sVlzJsYCXTLN9kJSnLpzmIcIbai2jFHtD5icsKLLx0RHJJZPe5Uw0cBLnFEN9udEXSur9vuIg0saMT-b_Uc5A-B2ZMZngXCWC3ObC4NRArnSRiauoEKWuMOwpPsXunrCtPn5LOKtE2PoU7fbmXkTbuWCsmoKrBZIuakRzrLig7NrtRIM8DfbvItFGIxEG2kJTpkyzQI4HzVGLRKJX6AiwTBqh-L67iciYrVGhUSzM4p1E4iN-16z_KqnhSU-6GgXA_l-FPLd9wDfRt0BKl9mmFz5iif44aKflCWS449bZh12SEJeAhCwu442E2Ldc4kiwn29r7AdH09fVx7st9WWMbhhcGfhbNEY9rvjrLKx_gamfZdnXI0nof3rqb-U5hLjYY2wUW5XTE2vHquX5JYHsUD_iYEPUOhdPzowKsKDqRTn2v9fLJe9lDutfm7Ywvax_W8oosxNT9jTbSAXnMuia3Lqr8UZwVNyJRm50VPDbtYriYv7p6YbbuV_HwTk29oskRoRVAcPB0U2nuNiJ1hWChzeGCa9XNcfThEr3BEo2b1jNcl-WOcLnRN2p3XzMe4ltGNECME31k8MmFTe64UeeidJtGAu9TCi1GOo7NQeD_62Jhn0OgByExoJ0WTf9J5HXhwSJo5wVk7Ua8tl6yO7X-LUeqI4EMNbYtdCVAUTyE4ij8OxYcvx8ciV4UNZJmu35tlRDnKsYCbSUSQMkDeGBND00sAAovkrMzmgKhvFdfTDJOwtj1so1sDVS_ZC1AXzAog=w2688-h1984)
+
+### **What is Arkos**
+
+**Arkos** is a **lightweight backend framework** for **Express.js and Prisma** that simplifies API development by providing automatic route generation, built-in authentication, error handling, and file upload optimization. Designed to be a foundational layer for backend applications, Arkos allows developers to quickly set up a secure and scalable server with minimal configuration.
+
+---
+
+### **Key Features**
+
+- 🚀 **Automatic API Generation** – Instantly create RESTful API routes for Prisma models.
+
+- 🔐 **Built-in Authentication** – Supports JWT-based authentication with effortless setup.
+
+- ⚡ **Express Middlewares** – Pre-configured security, request parsing, and error handling.
+
+- 🛡️ **Built-in Data Validation** – using class-validator and class-transformer, just drop a create-post.dto.ts.
+
+- ⬆️ **File Upload & Optimization** – Efficient image, video, docs, raw-file handling.
+
+- 💠 **Prisma Integration** – Seamless connection with Prisma ORM for database management with relation feilds handling.
+
+- 👨‍💻 **Interceptors Middlewares** – Tailor as you want, intercept, customize, for example using beforeCreateOne, afterSignUp.
+
+- ✉️ **Nodemailer Integration** – Seamless nodemailer integration for sending emails.
+
+With Arkos, developers can **bootstrap their backend in seconds**, focusing on building features rather than repetitive setup tasks.
+
+### 1. **Install the Package**
+
+Before running the code, make sure your package (`arkos`) is installed in your project. You can do this by running:
+
+```bash
+npm install arkos
+```
+
+or if you are using `pnpm`:
+
+```bash
+pnpm install arkos
+```
+
+### 2. **Setup Prisma Client**
+
+Here's how Prisma should be set up to use seamlessly with arkos:
+
+1. **Install Prisma and initialize it:**
+   Make sure you have Prisma installed in your project. You can install it using:
+
+   ```bash
+   npm install @prisma/client
+   npm install prisma --save-dev
+   ```
+
+2. **Set up your Prisma schema:**
+   You should have your `prisma/schema.prisma` file properly configured and migrate the database with Prisma commands:
+
+   ```bash
+   npx prisma generate
+   npx prisma migrate dev
+   ```
+
+3. **Initialize Prisma client:**
+   You'll need to have the `prisma` client initialized in your `src/utils/prisma.ts` file. For example:
+
+   ```typescript
+   // src/utils/prisma.ts
+   import { PrismaClient } from "@prisma/client";
+
+   export const prisma = new PrismaClient();
+   ```
+
+### 3. **Using `init` from `arkos`**
+
+The `init` function from your `arkos` package is used to initialize the app with required configurations. Here's how you can structure it:
+
+```typescript
+// src/app.ts
+import arkos from "arkos"; // Import arkos.init() from arkos package
+import express from "express"; // Import express
+
+// Initialize the Express app
+const app = express();
+
+// Call init and pass the Express app for configuration, app will listen in 8000 by default or set PORT in .env.developement or .env.production
+arkos.init(app);
+```
+
+### 4. **How `arkos.init()` Works:**
+
+- **Initialization**: The `arkos.init()` function is called with two arguments, the second being optional:
+  - `app`: The Express application instance.
+  - `options`: An object containing configurations for toggle `authentication` and pass the desired `port`.
+- **What happens under the hood**:
+  - **Authentication Setup**: The package will set (read further to learn how to prepare the environment) up authentication routes, middleware, and necessary handlers for managing user sessions and JWT tokens.
+  - **Error Handling**: Automatic error handling middleware could be added.
+  - **File Upload**: Arkos will configure necessary middleware to handle file uploads, image upload optimization, and route generation.
+  - **Prisma Integration**: The prisma instance must be export as default or as prisma under scr/utils/prisma.ts.
+
+### 5. **Additional Configuration (Optional)**
+
+You can customize additional settings such as routes for file uploads, email handling, and more, based on what your `arkos` package offers. The `arkos.init()` function may have additional configuration options, depending on how flexible and customizable the package is.
+
+---
+
+### Example Directory Structure
+
+Here is how the directory structure might look for this project:
+
+```
+project-root/
+│
+├── node_modules/
+│
+├── src/
+│   ├── utils/
+│   │   └── prisma.ts          # Prisma client initialization
+│   ├── app.ts                 # Express app setup with arkos.init()
+│
+├── package.json               # Your project dependencies
+└── prisma/
+    └── schema/
+        └── schema.prisma          # Your Prisma schema file
+        └── post.prisma          # Your Post model file
+```
+
+---
+
+### Example of `prisma/schema.prisma`:
+
+Ensure you have a basic Prisma schema like this:
+
+```typescript
+// prisma/schema.prisma
+datasource db {
+  provider = "sqlite" // Replace with your database provider (e.g., 'mongodb', 'mysql', 'sqlite', 'postgresql')
+  url      = env("DATABASE_URL")
+}
+
+generator client {
+  provider        = "prisma-client-js"
+  previewFeatures = ["prismaSchemaFolder"]
+}
+
+model Post {
+  id       Int     @id @default(autoincrement())
+  title    String  @unique
+  content String
+  createdAt DateTime @default(now())
+}
+```
+
+Run the following to generate the Prisma client:
+
+```bash
+npx prisma generate
+```
+
+After all there will be routes for
+
+- Find many, GET: /api/posts
+- Find one, GET: /api/posts/:id
+- Create one POST: /api/posts
+- Update one, PATCH: /api/posts/:id
+- Delete one, DELETE: /api/posts/:id
+
+---
+
+### Recap
+
+- You need `prisma` properly set up.
+- Once `arkos.init()` is invoked with your `express` app the package will handle routing, authentication, file uploads, etc., automatically.
+- Ensure you have all dependencies installed (`arkos`, `prisma`, `express`, etc.) before running the app.
+
+---
+
+## 📝 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+## 📫 Contact
+
+For any issues or questions, please open an issue or contact [Uanela Como](mailto:uanelaluiswayne@gmail.com).
+
+Feel free to reach out for questions, suggestions, or contributions ❤️.
+
+---
+
+### **Origin of the Name "Arkos"**
+
+The name **"Arkos"** is derived from the Greek word **ἀρχή (Arkhē)**, which means **"beginning"** or **"foundation"**. This interpretation perfectly aligns with the core purpose of the package — to serve as a **foundational layer** for quickly setting up backend systems. Just as **ἀρχή** represents the starting point or origin, Arkos is designed to **initiate** and **structure** backend projects, providing developers with a robust base to build upon.
+
+This makes Arkos an essential tool for **bootstrapping** and organizing backend applications, helping developers focus on features rather than repetitive setup tasks.
+
+---
+
+### NB: More documentation coming soon

package/dist/app.d.ts

@@ -1,7 +1,12 @@
 import express from "express";
+import { ClassValidatorInitConfigsOptions } from "./utils/validate-dto";
 export type InitConfigs = {
     port?: number;
     authentication?: boolean;
+    validation: ClassValidatorInitConfigsOptions | {
+        resolver: "zod";
+        validationOptions: Record<string, any>;
+    } | boolean;
 };
 declare let prisma: any;
 export declare function bootstrap(app: express.Express, configs: InitConfigs): Promise<express.Express>;

package/dist/app.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AA+B9B,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAGF,QAAA,IAAI,MAAM,EAAE,GAAG,CAAC;AAMhB,wBAAsB,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,4BA+DzE;AAED,OAAO,EAAE,MAAM,EAAE,CAAC"}
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAiB9B,OAAO,EAAE,gCAAgC,EAAE,MAAM,sBAAsB,CAAC;AA0BxE,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,UAAU,EACN,gCAAgC,GAChC;QACE,QAAQ,EAAE,KAAK,CAAC;QAChB,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACxC,GACD,OAAO,CAAC;CACb,CAAC;AAGF,QAAA,IAAI,MAAM,EAAE,GAAG,CAAC;AAMhB,wBAAsB,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,4BA+DzE;AAED,OAAO,EAAE,MAAM,EAAE,CAAC"}

package/dist/app.js

@@ -1,79 +1,51 @@
-"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.prisma = void 0;
-exports.bootstrap = bootstrap;
-const express_1 = __importDefault(require("express"));
-const body_parser_1 = __importDefault(require("body-parser"));
-const cors_1 = __importDefault(require("cors"));
-const cookie_parser_1 = __importDefault(require("cookie-parser"));
-const express_query_parser_1 = require("express-query-parser");
-const auth_router_1 = __importDefault(require("./modules/auth/auth.router"));
-const base_router_1 = __importDefault(require("./modules/base/base.router"));
-const error_handler_controller_1 = __importDefault(require("./modules/error-handler/error-handler.controller"));
-const express_rate_limit_1 = require("express-rate-limit");
-const path_1 = __importDefault(require("path"));
-const dotenv = __importStar(require("dotenv"));
-const compression_1 = __importDefault(require("compression"));
-const base_middlewares_1 = require("./modules/base/base.middlewares");
-const prisma_helpers_1 = require("./utils/helpers/prisma.helpers");
+import express from "express";
+import bodyParser from "body-parser";
+import cors from "cors";
+import cookieParser from "cookie-parser";
+import { queryParser } from "express-query-parser";
+import authRouter from "./modules/auth/auth.router";
+import baseRouter from "./modules/base/base.router";
+import errorHandler from "./modules/error-handler/error-handler.controller";
+import { rateLimit } from "express-rate-limit";
+import path from "path";
+import * as dotenv from "dotenv";
+import compression from "compression";
+import { handleRequestLogs } from "./modules/base/base.middlewares";
+import { checkDatabaseConnection, loadPrismaModule, } from "./utils/helpers/prisma.helpers";
 const ENV = process.env.NODE_ENV;
 let envPath = ".env";
+// Default to `.env.local` if available in any environment
 if (ENV === "production") {
-    envPath = path_1.default.resolve(process.cwd(), ".env.production");
+    envPath = path.resolve(process.cwd(), ".env.production");
 }
 else if (ENV === "staging") {
-    envPath = path_1.default.resolve(process.cwd(), ".env.staging");
+    envPath = path.resolve(process.cwd(), ".env.staging");
 }
 else if (ENV === "development") {
-    envPath = path_1.default.resolve(process.cwd(), ".env.development");
+    envPath = path.resolve(process.cwd(), ".env.development");
+}
+else if (ENV === "local") {
+    // For local development, .env.local can be used
+    envPath = path.resolve(process.cwd(), ".env.local");
+}
+// Optionally, add support for `.env.test`, `.env.qa`, or other environments if required
+else if (ENV === "test") {
+    envPath = path.resolve(process.cwd(), ".env.test");
+}
+else if (ENV === "qa") {
+    envPath = path.resolve(process.cwd(), ".env.qa");
 }
 dotenv.config({ path: envPath });
 let initConfigs;
 let prisma;
 (async () => {
-    exports.prisma = prisma = await (0, prisma_helpers_1.loadPrismaModule)();
+    prisma = await loadPrismaModule();
 })();
-async function bootstrap(app, configs) {
-    exports.prisma = prisma = await (0, prisma_helpers_1.loadPrismaModule)();
+export async function bootstrap(app, configs) {
+    prisma = await loadPrismaModule();
     initConfigs = configs;
-    app.use((0, compression_1.default)());
-    const limiter = (0, express_rate_limit_1.rateLimit)({
+    app.use(compression());
+    const limiter = rateLimit({
         windowMs: 60 * 1000,
         limit: 1000,
         standardHeaders: "draft-7",
@@ -81,7 +53,7 @@ async function bootstrap(app, configs) {
     });
     app.use(limiter);
     app.set("trust proxy", 1);
-    app.use("/api/uploads", express_1.default.static(path_1.default.join("uploads"), {
+    app.use("/api/uploads", express.static(path.join("uploads"), {
         maxAge: "1y",
         etag: true,
         lastModified: true,
@@ -90,7 +62,7 @@ async function bootstrap(app, configs) {
         index: false,
         cacheControl: true,
     }));
-    app.use((0, cors_1.default)({
+    app.use(cors({
         origin: (origin, callback) => {
             callback(null, true);
         },
@@ -98,21 +70,22 @@ async function bootstrap(app, configs) {
         allowedHeaders: ["Content-Type", "Authorization", "Connection"],
         credentials: true,
     }));
-    app.use(express_1.default.json());
-    app.use(body_parser_1.default.json());
-    app.use((0, cookie_parser_1.default)());
-    app.use((0, express_query_parser_1.queryParser)({
+    app.use(express.json());
+    app.use(bodyParser.json());
+    app.use(cookieParser());
+    app.use(queryParser({
         parseNull: true,
         parseUndefined: true,
         parseBoolean: true,
         parseNumber: true,
     }));
-    app.use((0, prisma_helpers_1.checkDatabaseConnection)(prisma));
-    app.use(base_middlewares_1.handleRequestLogs);
+    app.use(checkDatabaseConnection(prisma));
+    app.use(handleRequestLogs);
     if (configs.authentication)
-        app.use("/api", auth_router_1.default);
-    app.use("/api", base_router_1.default);
-    app.use(error_handler_controller_1.default);
+        app.use("/api", authRouter);
+    app.use("/api", baseRouter);
+    app.use(errorHandler);
     return app;
 }
+export { prisma };
 //# sourceMappingURL=app.js.map

package/dist/app.js.map

@@ -1 +1 @@
-{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,8BA+DC;AA1GD,sDAA8B;AAC9B,8DAAqC;AACrC,gDAAwB;AACxB,kEAAyC;AACzC,+DAAmD;AACnD,6EAAoD;AACpD,6EAAoD;AACpD,gHAA4E;AAC5E,2DAA+C;AAC/C,gDAAwB;AACxB,+CAAiC;AACjC,8DAAsC;AACtC,sEAAoE;AACpE,mEAGwC;AAExC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;AACjC,IAAI,OAAO,GAAG,MAAM,CAAC;AAErB,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;IACzB,OAAO,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,iBAAiB,CAAC,CAAC;AAC3D,CAAC;KAAM,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;IAC7B,OAAO,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC;AACxD,CAAC;KAAM,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;IACjC,OAAO,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,kBAAkB,CAAC,CAAC;AAC5D,CAAC;AAED,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;AAOjC,IAAI,WAAwB,CAAC;AAC7B,IAAI,MAAW,CAAC;AAEhB,CAAC,KAAK,IAAI,EAAE;IACV,iBAAA,MAAM,GAAG,MAAM,IAAA,iCAAgB,GAAE,CAAC;AACpC,CAAC,CAAC,EAAE,CAAC;AAEE,KAAK,UAAU,SAAS,CAAC,GAAoB,EAAE,OAAoB;IACxE,iBAAA,MAAM,GAAG,MAAM,IAAA,iCAAgB,GAAE,CAAC;IAElC,WAAW,GAAG,OAAO,CAAC;IAEtB,GAAG,CAAC,GAAG,CAAC,IAAA,qBAAW,GAAE,CAAC,CAAC;IAEvB,MAAM,OAAO,GAAG,IAAA,8BAAS,EAAC;QACxB,QAAQ,EAAE,EAAE,GAAG,IAAI;QACnB,KAAK,EAAE,IAAI;QACX,eAAe,EAAE,SAAS;QAC1B,aAAa,EAAE,KAAK;KACrB,CAAC,CAAC;IAEH,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAEjB,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;IAE1B,GAAG,CAAC,GAAG,CACL,cAAc,EACd,iBAAO,CAAC,MAAM,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;QACnC,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,IAAI;QACV,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,QAAQ;QAClB,WAAW,EAAE,IAAI;QACjB,KAAK,EAAE,KAAK;QACZ,YAAY,EAAE,IAAI;KACnB,CAAC,CACH,CAAC;IAEF,GAAG,CAAC,GAAG,CACL,IAAA,cAAI,EAAC;QACH,MAAM,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;YAC3B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC;QAC5D,cAAc,EAAE,CAAC,cAAc,EAAE,eAAe,EAAE,YAAY,CAAC;QAC/D,WAAW,EAAE,IAAI;KAClB,CAAC,CACH,CAAC;IAEF,GAAG,CAAC,GAAG,CAAC,iBAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACxB,GAAG,CAAC,GAAG,CAAC,qBAAU,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3B,GAAG,CAAC,GAAG,CAAC,IAAA,uBAAY,GAAE,CAAC,CAAC;IACxB,GAAG,CAAC,GAAG,CACL,IAAA,kCAAW,EAAC;QACV,SAAS,EAAE,IAAI;QACf,cAAc,EAAE,IAAI;QACpB,YAAY,EAAE,IAAI;QAClB,WAAW,EAAE,IAAI;KAClB,CAAC,CACH,CAAC;IAEF,GAAG,CAAC,GAAG,CAAC,IAAA,wCAAuB,EAAC,MAAM,CAAC,CAAC,CAAC;IAEzC,GAAG,CAAC,GAAG,CAAC,oCAAiB,CAAC,CAAC;IAE3B,IAAI,OAAO,CAAC,cAAc;QAAE,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,qBAAU,CAAC,CAAC;IACxD,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,qBAAU,CAAC,CAAC;IAC5B,GAAG,CAAC,GAAG,CAAC,kCAAY,CAAC,CAAC;IAEtB,OAAO,GAAG,CAAC;AACb,CAAC"}
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,YAAY,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,UAAU,MAAM,4BAA4B,CAAC;AACpD,OAAO,UAAU,MAAM,4BAA4B,CAAC;AACpD,OAAO,YAAY,MAAM,kDAAkD,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AACjC,OAAO,WAAW,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EACL,uBAAuB,EACvB,gBAAgB,GACjB,MAAM,gCAAgC,CAAC;AAGxC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;AACjC,IAAI,OAAO,GAAG,MAAM,CAAC;AAErB,0DAA0D;AAC1D,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;IACzB,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,iBAAiB,CAAC,CAAC;AAC3D,CAAC;KAAM,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;IAC7B,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC;AACxD,CAAC;KAAM,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;IACjC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,kBAAkB,CAAC,CAAC;AAC5D,CAAC;KAAM,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;IAC3B,gDAAgD;IAChD,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,YAAY,CAAC,CAAC;AACtD,CAAC;AAED,wFAAwF;KACnF,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;IACxB,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,WAAW,CAAC,CAAC;AACrD,CAAC;KAAM,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;IACxB,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;AAcjC,IAAI,WAAwB,CAAC;AAC7B,IAAI,MAAW,CAAC;AAEhB,CAAC,KAAK,IAAI,EAAE;IACV,MAAM,GAAG,MAAM,gBAAgB,EAAE,CAAC;AACpC,CAAC,CAAC,EAAE,CAAC;AAEL,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,GAAoB,EAAE,OAAoB;IACxE,MAAM,GAAG,MAAM,gBAAgB,EAAE,CAAC;IAElC,WAAW,GAAG,OAAO,CAAC;IAEtB,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;IAEvB,MAAM,OAAO,GAAG,SAAS,CAAC;QACxB,QAAQ,EAAE,EAAE,GAAG,IAAI;QACnB,KAAK,EAAE,IAAI;QACX,eAAe,EAAE,SAAS;QAC1B,aAAa,EAAE,KAAK;KACrB,CAAC,CAAC;IAEH,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAEjB,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;IAE1B,GAAG,CAAC,GAAG,CACL,cAAc,EACd,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;QACnC,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,IAAI;QACV,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,QAAQ;QAClB,WAAW,EAAE,IAAI;QACjB,KAAK,EAAE,KAAK;QACZ,YAAY,EAAE,IAAI;KACnB,CAAC,CACH,CAAC;IAEF,GAAG,CAAC,GAAG,CACL,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;YAC3B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC;QAC5D,cAAc,EAAE,CAAC,cAAc,EAAE,eAAe,EAAE,YAAY,CAAC;QAC/D,WAAW,EAAE,IAAI;KAClB,CAAC,CACH,CAAC;IAEF,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACxB,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3B,GAAG,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC;IACxB,GAAG,CAAC,GAAG,CACL,WAAW,CAAC;QACV,SAAS,EAAE,IAAI;QACf,cAAc,EAAE,IAAI;QACpB,YAAY,EAAE,IAAI;QAClB,WAAW,EAAE,IAAI;KAClB,CAAC,CACH,CAAC;IAEF,GAAG,CAAC,GAAG,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC,CAAC;IAEzC,GAAG,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAE3B,IAAI,OAAO,CAAC,cAAc;QAAE,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACxD,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC5B,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAEtB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,OAAO,EAAE,MAAM,EAAE,CAAC"}

package/dist/exports/error-handler/index.d.ts

@@ -0,0 +1,14 @@
+import AppError from "../../modules/error-handler/utils/app-error";
+/**
+ * A collection of error handling utilities.
+ *
+ * @namespace errorHandler
+ * @property {Function} catchAsync - A function to catch asynchronous errors.
+ * @property {Class} AppError - The AppError class to handle errors.
+ */
+export declare const errorHandler: {
+    catchAsync: (fn: import("express").RequestHandler) => (req: import("express").Request, res: import("express").Response, next: import("express").NextFunction) => void;
+    AppError: typeof AppError;
+};
+export default errorHandler;
+//# sourceMappingURL=index.d.ts.map

package/dist/exports/error-handler/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/exports/error-handler/index.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,6CAA6C,CAAC;AAEnE;;;;;;GAMG;AACH,eAAO,MAAM,YAAY;2DAMqL,8BAAY,EAAC,+BAAc,EAAC,oCAAmB;;CAH5P,CAAC;AAEF,eAAe,YAAY,CAAC"}

package/dist/exports/error-handler/index.js

@@ -0,0 +1,15 @@
+import catchAsync from "../../modules/error-handler/utils/catch-async";
+import AppError from "../../modules/error-handler/utils/app-error";
+/**
+ * A collection of error handling utilities.
+ *
+ * @namespace errorHandler
+ * @property {Function} catchAsync - A function to catch asynchronous errors.
+ * @property {Class} AppError - The AppError class to handle errors.
+ */
+export const errorHandler = {
+    catchAsync,
+    AppError,
+};
+export default errorHandler;
+//# sourceMappingURL=index.js.map

package/dist/exports/error-handler/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/exports/error-handler/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,+CAA+C,CAAC;AACvE,OAAO,QAAQ,MAAM,6CAA6C,CAAC;AAEnE;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,UAAU;IACV,QAAQ;CACT,CAAC;AAEF,eAAe,YAAY,CAAC"}