@codenokami/node-api-master 1.4.0 → 1.4.2

package/README.md

@@ -1,164 +1,99 @@
-# @cnk/node-api-master 🚀
+# @codenokami/node-api-master 🚀
 
-A robust, professional-grade utility package for Express.js APIs. This package simplifies database connections, authentication, real-time communication with Socket.io, error handling, and request validation.
+A modern, robust, and professional Node.js utility package for building scalable REST APIs. Built with **ES Modules** and **TypeScript Support**, providing dual-format (CJS & ESM) compatibility.
 
 ---
 
-## 📦 Installation
-
-This package is designed to work with **mongoose** and **socket.io** as peer dependencies to avoid version conflicts.
-
-```bash
-# Install the core package
-npm install @cnk/node-api-master
-
-# Install required peer dependencies
-npm install mongoose socket.io
-
-```
-
----
+## ✨ Features
 
-## 📂 Features
-
-- **🛡 Auth & Admin Middleware**: JWT-based route protection and role-based access control.
-- **🔌 Socket.io Helper**: Integrated real-time communication with JWT authentication support.
-- **🚨 Global Error Handler**: Centralized error management using the `AppError` class.
-- **⚡ CatchAsync Utility**: Eliminate repetitive `try-catch` blocks in your controllers.
-- **✅ Joi Validation**: Pre-defined and custom schemas for request validation.
-- **🔗 DB Helper**: Simplified MongoDB connection setup.
-- **📊 Standardized Responses**: Uniform success and error API response formats.
+- 🛠 **Standard API Response**: Consistent success and error response wrappers.
+- 🛡 **Global Error Handling**: Centralized error middleware with operational vs programming error detection.
+- ⚡ **Async Handler**: Eliminate the need for messy `try-catch` blocks in controllers.
+- 🧪 **Joi Validations**: Pre-defined schemas for users, object IDs, and pagination.
+- 🔑 **Auth Helpers**: Robust password hashing and JWT management.
+- 🆔 **Secure UUID**: RFC 4122 compliant UUID v4 generator.
+- 🔌 **Socket.io Auth**: Middleware for securing your real-time connections.
 
 ---
 
-## 📖 Detailed Usage Guide
-
-### 1. Database Connection & Server Setup
-
-Handle dynamic ports and database connections efficiently.
-
-```javascript
-const { connectDB, STATUS_CODES } = require("@cnk/node-api-master");
-
-// Start DB
-connectDB(process.env.MONGO_URI);
+## 📦 Installation
 
-// Dynamic Port
-const PORT = process.env.PORT || 5000;
-app.listen(PORT, () => console.log(`Server running on port ${PORT}`));
+```bash
+npm install @codenokami/node-api-master
 ```
 
 ---
 
-### 2. Socket.io with Authentication
-
-Setup a secure real-time server. The middleware automatically verifies tokens from `socket.handshake.auth.token`.
-
-```javascript
-const http = require("http");
-const { socket } = require("@cnk/node-api-master");
-
-const server = http.createServer(app);
-
-// Initialize Socket with JWT protection
-const io = socket.initSocket(server, {
-  authRequired: true,
-  jwtSecret: process.env.JWT_SECRET,
-});
-
-io.on("connection", (s) => {
-  console.log("Authenticated User ID:", s.user.id);
-});
-
-server.listen(PORT);
-```
+## 🚀 Quick Start
 
----
-
-### 3. Authentication Middleware (HTTP)
+### 1. Setup Global Error Middleware
 
-Protect your Express routes using JWT.
+In your main app file (e.g., `index.js` or `app.js`):
 
 ```javascript
-const { auth, admin } = require("@cnk/node-api-master");
-
-// Protect a route
-router.get("/me", auth(), userController.getMe);
-
-// Admin only route
-router.delete("/users/:id", auth(), admin, userController.deleteUser);
-```
-
----
-
-### 4. Request Validation (Joi)
-
-Validate incoming request bodies, params, or queries.
+import express from "express";
+import { errorMiddleware } from "@codenokami/node-api-master";
 
-```javascript
-const { validate, schemas, Joi } = require("@cnk/node-api-master");
+const app = express();
 
-// Use pre-built schemas
-router.post("/login", validate(schemas.user.login), authController.login);
+// ... your routes ...
 
-// Use custom schema
-const profileSchema = Joi.object({
-  bio: Joi.string().max(200),
-  website: Joi.string().uri(),
-});
-router.put("/profile", validate(profileSchema), userController.updateProfile);
+// Must be at the end of all routes
+app.use(errorMiddleware);
 ```
 
----
-
-### 5. Standardized Responses & Error Handling
+### 2. Using catchAsync & apiResponse
 
-Keep your API responses consistent across the entire project.
+Clean up your controllers easily:
 
 ```javascript
-const {
-  catchAsync,
-  AppError,
-  apiResponse,
-  STATUS_CODES,
-} = require("@cnk/node-api-master");
-
-exports.getUser = catchAsync(async (req, res, next) => {
+import { catchAsync, apiResponse, AppError } from "@codenokami/node-api-master";
+
+export const getUser = catchAsync(async (req, res, next) => {
   const user = await User.findById(req.params.id);
 
   if (!user) {
-    return next(new AppError("User not found!", STATUS_CODES.NOT_FOUND));
+    return next(new AppError("User not found", 404));
   }
 
-  apiResponse.success(res, user, "User retrieved successfully");
+  return apiResponse.success(res, user, "User retrieved successfully");
 });
 ```
 
----
-
-### 6. Global Error Middleware
+### 3. Validating Requests
 
-**Mandatory:** Register this at the very end of your middleware stack in `app.js`.
+Use pre-built Joi schemas:
 
 ```javascript
-const { errorMiddleware } = require("@cnk/node-api-master");
-
-// After all your routes
-app.use(errorMiddleware);
+import { validate, schemas } from "@codenokami/node-api-master";
+
+// Apply validation as middleware
+router.post(
+  "/register",
+  validate(schemas.user.register),
+  authController.register,
+);
 ```
 
 ---
 
-## 🛠 Project Structure
+## 🛠 Utilities Reference
 
-- `src/db`: Mongoose connection helpers.
-- `src/middleware`: Auth, Admin, Validation, and Global Error handlers.
-- `src/socket`: Socket.io initialization and JWT middleware.
-- `src/utils`: `AppError`, `catchAsync`, and API response helpers.
-- `src/validations`: Reusable Joi schemas.
+| Utility                                | Description                                                |
+| -------------------------------------- | ---------------------------------------------------------- |
+| `generateUUID()`                       | Returns a secure v4 UUID string.                           |
+| `authHelper.hashPassword(pw)`          | Hashes password using bcrypt.                              |
+| `authHelper.comparePassword(pw, hash)` | Compares plain text password with hash.                    |
+| `STATUS_CODES`                         | Standard HTTP Status codes (OK: 200, NOT_FOUND: 404, etc.) |
 
 ---
 
-## 📄 License
+## 🏗 Build Status
+
+- **ES Modules (ESM)**: Supported (`.mjs`)
+- **CommonJS (CJS)**: Supported (`.cjs`)
+- **TypeScript**: Type definitions included (`.d.ts`)
+
+## 📜 License
 
-MIT © CNK
+MIT © CodeNoKami

package/dist/index.d.mts

@@ -240,10 +240,6 @@ const apiResponse = {
   },
 };
 
-declare namespace response {
-  export { apiResponse as default };
-}
-
 /**
  * Password ကို Hash လုပ်ရန်
  */
@@ -433,4 +429,4 @@ declare namespace index {
   export { index_getIO as getIO, index_initSocket as initSocket };
 }
 
-export { AppError, STATUS_CODES, admin, response as apiResponse, auth, catchAsync, comparePassword, connectDB, errorMiddleware, generateToken, generateUUID, hashPassword, schemas, index as socket, validate };
+export { AppError, STATUS_CODES, admin, apiResponse, auth, catchAsync, comparePassword, connectDB, errorMiddleware, generateToken, generateUUID, hashPassword, schemas, index as socket, validate };

package/dist/index.d.ts

@@ -240,10 +240,6 @@ const apiResponse = {
   },
 };
 
-declare namespace response {
-  export { apiResponse as default };
-}
-
 /**
  * Password ကို Hash လုပ်ရန်
  */
@@ -433,4 +429,4 @@ declare namespace index {
   export { index_getIO as getIO, index_initSocket as initSocket };
 }
 
-export { AppError, STATUS_CODES, admin, response as apiResponse, auth, catchAsync, comparePassword, connectDB, errorMiddleware, generateToken, generateUUID, hashPassword, schemas, index as socket, validate };
+export { AppError, STATUS_CODES, admin, apiResponse, auth, catchAsync, comparePassword, connectDB, errorMiddleware, generateToken, generateUUID, hashPassword, schemas, index as socket, validate };

package/dist/index.js

@@ -33,7 +33,7 @@ __export(index_exports, {
   Joi: () => import_joi3.default,
   STATUS_CODES: () => constants_default,
   admin: () => admin,
-  apiResponse: () => response_exports,
+  apiResponse: () => response_default,
   auth: () => auth,
   catchAsync: () => catchAsync_default,
   comparePassword: () => comparePassword,
@@ -224,10 +224,6 @@ var errorMiddleware = (err, req, res, next) => {
 var errorMiddleware_default = errorMiddleware;
 
 // src/utils/response.js
-var response_exports = {};
-__export(response_exports, {
-  default: () => response_default
-});
 var apiResponse = {
   // အောင်မြင်တဲ့ response ပေးပို့ရန်
   success: (res, data, message = "Success", statusCode = constants_default.OK) => {

package/dist/index.mjs

@@ -182,10 +182,6 @@ var errorMiddleware = (err, req, res, next) => {
 var errorMiddleware_default = errorMiddleware;
 
 // src/utils/response.js
-var response_exports = {};
-__export(response_exports, {
-  default: () => response_default
-});
 var apiResponse = {
   // အောင်မြင်တဲ့ response ပေးပို့ရန်
   success: (res, data, message = "Success", statusCode = constants_default.OK) => {
@@ -357,7 +353,7 @@ export {
   Joi3 as Joi,
   constants_default as STATUS_CODES,
   admin,
-  response_exports as apiResponse,
+  response_default as apiResponse,
   auth,
   catchAsync_default as catchAsync,
   comparePassword,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codenokami/node-api-master",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "description": "Professional utility package for Express.js APIs with Auth, Socket, and Error Handling",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",