@hichchi/nest-connector 0.0.2 → 0.0.4

package/auth.cjs.js

@@ -247,6 +247,8 @@ exports.AuthEndpoint = void 0;
  * - `USER_404_ID`: User not found.
  * - `USER_409_EXIST_UNAME`: Username already exists.
  * - `USER_500_CREATE`: User creation error.
+ *
+ * @see {@link AuthErrors} for error responses
  */
 exports.AuthErrorResponseCode = void 0;
 (function (AuthErrorResponseCode) {
@@ -427,6 +429,11 @@ exports.AuthErrorResponseCode = void 0;
    * Occurs when there is a server-side error during the authentication process.
    */
   AuthErrorResponseCode["AUTH_500_SIGN_IN"] = "AUTH_500_SIGN_IN";
+  /**
+   * Change password error (500 Internal Server Error)
+   * Occurs when there is a server-side error during the change password process.
+   */
+  AuthErrorResponseCode["AUTH_500_CHANGE_PASSWORD"] = "AUTH_500_CHANGE_PASSWORD";
   /**
    * Social sign in error (500 Internal Server Error)
    *
@@ -1003,6 +1010,11 @@ const AuthErrors = {
     code: exports.AuthErrorResponseCode.AUTH_500_SIGN_IN,
     message: "Error occurred while signing in!"
   },
+  [exports.AuthErrorResponseCode.AUTH_500_CHANGE_PASSWORD]: {
+    statusCode: error_responses.HttpServerErrorStatus.INTERNAL_SERVER_ERROR,
+    code: exports.AuthErrorResponseCode.AUTH_500_CHANGE_PASSWORD,
+    message: "Error occurred while changing password!"
+  },
   [exports.AuthErrorResponseCode.AUTH_500_SOCIAL_SIGN_IN]: {
     statusCode: error_responses.HttpServerErrorStatus.INTERNAL_SERVER_ERROR,
     code: exports.AuthErrorResponseCode.AUTH_500_SOCIAL_SIGN_IN,
@@ -1275,7 +1287,7 @@ const AuthSuccessResponses = {
  * @see {@link Role} Interface defining the structure of role objects
  */
 function isRoleObject(role) {
-  return Boolean(role) && Boolean("name" in role);
+  return Boolean(role) && typeof role === "object" && Boolean("name" in role);
 }
 
 exports.AuthErrors = AuthErrors;

package/auth.esm.js

@@ -245,6 +245,8 @@ var AuthEndpoint;
  * - `USER_404_ID`: User not found.
  * - `USER_409_EXIST_UNAME`: Username already exists.
  * - `USER_500_CREATE`: User creation error.
+ *
+ * @see {@link AuthErrors} for error responses
  */
 var AuthErrorResponseCode;
 (function (AuthErrorResponseCode) {
@@ -425,6 +427,11 @@ var AuthErrorResponseCode;
    * Occurs when there is a server-side error during the authentication process.
    */
   AuthErrorResponseCode["AUTH_500_SIGN_IN"] = "AUTH_500_SIGN_IN";
+  /**
+   * Change password error (500 Internal Server Error)
+   * Occurs when there is a server-side error during the change password process.
+   */
+  AuthErrorResponseCode["AUTH_500_CHANGE_PASSWORD"] = "AUTH_500_CHANGE_PASSWORD";
   /**
    * Social sign in error (500 Internal Server Error)
    *
@@ -1001,6 +1008,11 @@ const AuthErrors = {
     code: AuthErrorResponseCode.AUTH_500_SIGN_IN,
     message: "Error occurred while signing in!"
   },
+  [AuthErrorResponseCode.AUTH_500_CHANGE_PASSWORD]: {
+    statusCode: HttpServerErrorStatus.INTERNAL_SERVER_ERROR,
+    code: AuthErrorResponseCode.AUTH_500_CHANGE_PASSWORD,
+    message: "Error occurred while changing password!"
+  },
   [AuthErrorResponseCode.AUTH_500_SOCIAL_SIGN_IN]: {
     statusCode: HttpServerErrorStatus.INTERNAL_SERVER_ERROR,
     code: AuthErrorResponseCode.AUTH_500_SOCIAL_SIGN_IN,
@@ -1273,7 +1285,7 @@ const AuthSuccessResponses = {
  * @see {@link Role} Interface defining the structure of role objects
  */
 function isRoleObject(role) {
-  return Boolean(role) && Boolean("name" in role);
+  return Boolean(role) && typeof role === "object" && Boolean("name" in role);
 }
 
 export { AuthEndpoint, AuthErrorResponseCode, AuthErrors, AuthField, AuthMethod, AuthProvider, AuthStrategy, AuthSuccessResponseCode, AuthSuccessResponses, isRoleObject };

package/crud.cjs.js

@@ -7,26 +7,3 @@ exports.CrudEndpoint = void 0;
   CrudEndpoint["BY_IDS"] = "by-ids";
   CrudEndpoint["DELETE_BY_IDS"] = "delete-by-ids";
 })(exports.CrudEndpoint || (exports.CrudEndpoint = {}));
-
-// noinspection JSUnusedGlobalSymbols
-const x = {
-  where: {
-    id: "s",
-    company: {
-      subdomain: "subdomain"
-    }
-  }
-};
-const y = {
-  where: {
-    id: ["s"],
-    company: {
-      subdomain: "subdomain"
-    }
-  }
-};
-// eslint-disable-next-line no-console
-console.log({
-  x,
-  y
-});

package/crud.esm.js

@@ -6,27 +6,4 @@ var CrudEndpoint;
   CrudEndpoint["DELETE_BY_IDS"] = "delete-by-ids";
 })(CrudEndpoint || (CrudEndpoint = {}));
 
-// noinspection JSUnusedGlobalSymbols
-const x = {
-  where: {
-    id: "s",
-    company: {
-      subdomain: "subdomain"
-    }
-  }
-};
-const y = {
-  where: {
-    id: ["s"],
-    company: {
-      subdomain: "subdomain"
-    }
-  }
-};
-// eslint-disable-next-line no-console
-console.log({
-  x,
-  y
-});
-
 export { CrudEndpoint };

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@hichchi/nest-connector",
-  "version": "0.0.2",
+  "description": "Comprehensive NestJS connector library providing standardized HTTP responses, authentication interfaces, CRUD operations, and shared utilities for the Hichchi ecosystem",
+  "version": "0.0.4",
   "publishConfig": {
     "access": "public"
   },

package/readme-top.md

@@ -0,0 +1,170 @@
+
+<!--suppress ALL -->
+<div align="center">
+
+# 🔗 @hichchi/nest-connector
+
+## Description
+
+**Comprehensive NestJS connector library providing standardized HTTP responses, authentication interfaces, CRUD operations, and shared utilities for the Hichchi ecosystem**
+
+[![npm version](https://img.shields.io/npm/v/@hichchi/nest-connector?style=flat&color=blue)](https://www.npmjs.com/package/@hichchi/nest-connector)
+[![npm downloads](https://img.shields.io/npm/dm/@hichchi/nest-connector?style=flat&color=green)](https://www.npmjs.com/package/@hichchi/nest-connector)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/hichchidev/hichchi/blob/main/LICENSE)
+[![NestJS](https://img.shields.io/badge/nestjs-11.1.3-red.svg)](https://nestjs.com/)
+
+*Part of the [Hichchi](https://github.com/hichchidev/hichchi) ecosystem - A powerful, scalable application built with Nx workspace*
+
+[📚 Jump to Documentation](#-api-documentation)
+
+</div>
+
+---
+
+## 📋 Table of Contents
+
+- [📦 Installation](#-installation)
+- [⚡ Quick Start](#-quick-start)
+- [📋 Prerequisites](#-prerequisites)
+- [🌟 Overview](#-overview)
+- [✨ Features](#-features)
+- [🔧 Development](#-development)
+- [📖 API Documentation](#-api-documentation)
+
+---
+
+## 📦 Installation
+
+```bash
+npm install @hichchi/nest-connector
+```
+
+## ⚡ Quick Start
+
+Get up and running with standardized API responses in just a few minutes:
+
+```typescript
+// 1. Install the package
+npm install @hichchi/nest-connector
+
+// 2. Import response interfaces and builders
+import { 
+  HttpResponse, 
+  SuccessResponse, 
+  ErrorResponse,
+  SuccessResponseDto 
+} from '@hichchi/nest-connector';
+
+// 3. Use in your NestJS controllers
+@Controller('users')
+export class UsersController {
+  @Get()
+  async getUsers(): Promise<SuccessResponse> {
+    const users = await this.usersService.findAll();
+    return new SuccessResponseDto(users, 'Users retrieved successfully');
+  }
+}
+```
+
+## 📋 Prerequisites
+
+Before installing @hichchi/nest-connector, ensure you have:
+
+### Required Dependencies
+- **Node.js**: ^20.0.0
+- **NestJS**: ^11.0.0
+- **TypeScript**: ~5.9.3
+
+### Peer Dependencies
+```bash
+npm install @nestjs/common @nestjs/core
+npm install rxjs reflect-metadata
+```
+
+### Internal Dependencies
+This package depends on:
+```bash
+npm install @hichchi/utils
+```
+
+### Optional Dependencies
+For enhanced features:
+```bash
+# For validation decorators
+npm install class-validator class-transformer
+```
+
+## 🌟 Overview
+
+🎯 **Your standardized response toolkit** for NestJS applications. Ensure consistent API responses across your entire application with pre-defined interfaces, builders, and response structures that follow industry best practices.
+
+## ✨ Features
+
+### 🏗️ Ready-to-Use Response Structures
+- 📋 **HttpResponse Interface** - Base interface for all API responses
+- ✅ **SuccessResponse Interface** - Standardized success response structure
+- ❌ **ErrorResponse Interface** - Consistent error response format
+- 🔢 **HTTP Status Enums** - Pre-defined status code enumerations
+
+### 🛠️ Response Builders & DTOs
+- 🏭 **SuccessResponseDto** - Builder for success responses with data
+- 🎯 **Response Code Types** - Application-specific response codes
+- 📊 **Status Code Management** - Organized HTTP status code handling
+- 🔧 **Type-Safe Responses** - Full TypeScript support for response structures
+
+### 🎨 Developer Experience
+- 📝 **Comprehensive Documentation** - Detailed JSDoc comments for all interfaces
+- 🔍 **IntelliSense Support** - Full IDE autocomplete and type checking
+- 🎯 **Consistent API Design** - Standardized response patterns across applications
+- 🚀 **Easy Integration** - Drop-in replacement for custom response handling
+
+### 🔧 Advanced Features
+- 🏷️ **User Info Interfaces** - Standardized user information structures
+- 📦 **Modular Design** - Import only what you need
+- 🔄 **Extensible Architecture** - Easy to extend with custom response types
+- 🎪 **Framework Agnostic Types** - Core interfaces can be used beyond NestJS
+
+## 🔧 Development
+
+### Building the Library
+```bash
+nx build nest-connector
+```
+
+### Running Tests
+```bash
+nx test nest-connector
+```
+
+### Linting
+```bash
+nx lint nest-connector
+```
+
+---
+
+<div align="center">
+
+**Made with ❤️ by [Hichchi Dev](https://github.com/hichchidev)**
+
+[![Hichchi Ecosystem](https://img.shields.io/badge/🏠_Hichchi_Ecosystem-blue)](https://github.com/hichchidev/hichchi)
+[![Report Bug](https://img.shields.io/badge/🐛_Report_Bug-red)](https://github.com/hichchidev/hichchi/issues)
+[![Request Feature](https://img.shields.io/badge/✨_Request_Feature-green)](https://github.com/hichchidev/hichchi/issues)
+
+*Standardizing API responses and connecting NestJS applications with consistent interfaces and shared utilities*
+
+</div>
+
+---
+
+# 📖 API Documentation
+
+Complete technical reference for all classes, interfaces, methods, and types in this library.
+
+**Auto-generated by TypeDoc** - Browse through detailed API references, code examples, and implementation guides below.
+
+<!-- TypeDoc generated documentation will be appended below this point -->
+
+---
+
+## 📋 API Table of Contents

package/src/auth/enums/auth-error-response.enum.d.ts

@@ -66,6 +66,8 @@
  * - `USER_404_ID`: User not found.
  * - `USER_409_EXIST_UNAME`: Username already exists.
  * - `USER_500_CREATE`: User creation error.
+ *
+ * @see {@link AuthErrors} for error responses
  */
 export declare enum AuthErrorResponseCode {
     /**
@@ -245,6 +247,11 @@ export declare enum AuthErrorResponseCode {
      * Occurs when there is a server-side error during the authentication process.
      */
     AUTH_500_SIGN_IN = "AUTH_500_SIGN_IN",
+    /**
+     * Change password error (500 Internal Server Error)
+     * Occurs when there is a server-side error during the change password process.
+     */
+    AUTH_500_CHANGE_PASSWORD = "AUTH_500_CHANGE_PASSWORD",
     /**
      * Social sign in error (500 Internal Server Error)
      *