@hichchi/nest-connector 0.0.3 → 0.0.5

package/auth.cjs.js

@@ -2,6 +2,39 @@
 
 var error_responses = require('./error.responses.cjs.js');
 
+/**
+ * Header key for tenant identification
+ *
+ * This constant defines the HTTP header used to indicate the tenant in a request,
+ * typically in multi-tenant applications. The value should be sent by the client
+ * (or upstream gateway) in each request, for example as "x-tenant".
+ *
+ * Controllers and services can read this header directly from the request object
+ * to perform tenant-specific logic.
+ *
+ * Using a constant prevents magic strings and ensures consistency across the app.
+ *
+ * @example
+ * ```typescript
+ * // Controller accessing the tenant directly from the header
+ * @Controller()
+ * export class SomeController {
+ *   @Get()
+ *   findAll(@Req() req: Request) {
+ *     const tenant = req.header(TENANT_HEADER_KEY);
+ *
+ *     if (tenant) {
+ *       // Perform tenant-specific operations
+ *       return this.service.findAllForTenant(tenant);
+ *     }
+ *
+ *     return this.service.findAll();
+ *   }
+ * }
+ * ```
+ */
+const TENANT_HEADER_KEY = "x-tenant";
+
 /**
  * Authentication Endpoints Enum
  *
@@ -1287,9 +1320,10 @@ 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;
 exports.AuthSuccessResponses = AuthSuccessResponses;
+exports.TENANT_HEADER_KEY = TENANT_HEADER_KEY;
 exports.isRoleObject = isRoleObject;

package/auth.esm.js

@@ -1,5 +1,38 @@
 import { e as HttpServerErrorStatus, H as HttpClientErrorStatus, f as HttpSuccessStatus } from './error.responses.esm.js';
 
+/**
+ * Header key for tenant identification
+ *
+ * This constant defines the HTTP header used to indicate the tenant in a request,
+ * typically in multi-tenant applications. The value should be sent by the client
+ * (or upstream gateway) in each request, for example as "x-tenant".
+ *
+ * Controllers and services can read this header directly from the request object
+ * to perform tenant-specific logic.
+ *
+ * Using a constant prevents magic strings and ensures consistency across the app.
+ *
+ * @example
+ * ```typescript
+ * // Controller accessing the tenant directly from the header
+ * @Controller()
+ * export class SomeController {
+ *   @Get()
+ *   findAll(@Req() req: Request) {
+ *     const tenant = req.header(TENANT_HEADER_KEY);
+ *
+ *     if (tenant) {
+ *       // Perform tenant-specific operations
+ *       return this.service.findAllForTenant(tenant);
+ *     }
+ *
+ *     return this.service.findAll();
+ *   }
+ * }
+ * ```
+ */
+const TENANT_HEADER_KEY = "x-tenant";
+
 /**
  * Authentication Endpoints Enum
  *
@@ -1285,7 +1318,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 };
+export { AuthEndpoint, AuthErrorResponseCode, AuthErrors, AuthField, AuthMethod, AuthProvider, AuthStrategy, AuthSuccessResponseCode, AuthSuccessResponses, TENANT_HEADER_KEY, 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/index.cjs.js

@@ -110,6 +110,7 @@ class SuccessResponseDto {
   }
 }
 
+// noinspection JSUnusedGlobalSymbols
 const SECOND_IN_MS = 1000;
 const MINUTE_IN_SECONDS = 60;
 const HOUR_IN_MINUTES = 60;

package/index.esm.js

@@ -109,6 +109,7 @@ class SuccessResponseDto {
   }
 }
 
+// noinspection JSUnusedGlobalSymbols
 const SECOND_IN_MS = 1000;
 const MINUTE_IN_SECONDS = 60;
 const HOUR_IN_MINUTES = 60;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hichchi/nest-connector",
   "description": "Comprehensive NestJS connector library providing standardized HTTP responses, authentication interfaces, CRUD operations, and shared utilities for the Hichchi ecosystem",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "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/auth.d.ts

@@ -1,3 +1,4 @@
+export * from "./constants";
 export * from "./enums";
 export * from "./interfaces";
 export * from "./responses";

package/src/auth/constants/constants.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Header key for tenant identification
+ *
+ * This constant defines the HTTP header used to indicate the tenant in a request,
+ * typically in multi-tenant applications. The value should be sent by the client
+ * (or upstream gateway) in each request, for example as "x-tenant".
+ *
+ * Controllers and services can read this header directly from the request object
+ * to perform tenant-specific logic.
+ *
+ * Using a constant prevents magic strings and ensures consistency across the app.
+ *
+ * @example
+ * ```typescript
+ * // Controller accessing the tenant directly from the header
+ * @Controller()
+ * export class SomeController {
+ *   @Get()
+ *   findAll(@Req() req: Request) {
+ *     const tenant = req.header(TENANT_HEADER_KEY);
+ *
+ *     if (tenant) {
+ *       // Perform tenant-specific operations
+ *       return this.service.findAllForTenant(tenant);
+ *     }
+ *
+ *     return this.service.findAll();
+ *   }
+ * }
+ * ```
+ */
+export declare const TENANT_HEADER_KEY = "x-tenant";

package/src/auth/constants/index.d.ts

@@ -0,0 +1 @@
+export * from "./constants";

package/src/auth/types/types.d.ts

@@ -169,3 +169,13 @@ export type RefreshToken = string & {
 export type VerifyToken = string & {
     readonly __brand: unique symbol;
 };
+/**
+ * A type representing a tenant-specific slug with a unique branding.
+ * This type is used to distinguish tenant slugs from regular strings at the type level.
+ * The `__brand` symbol ensures that type operations preserve the distinction.
+ *
+ * Usage of this type prevents accidental misuse of strings in contexts where a tenant slug is required.
+ */
+export type TenantSlug = string & {
+    readonly __brand: unique symbol;
+};

package/src/common/interfaces/user-info.interface.d.ts

@@ -1,3 +1,4 @@
+import { TenantSlug } from "../../auth";
 import { EntityId } from "../../crud";
 /**
  * Interface representing essential user information.
@@ -40,6 +41,16 @@ export interface UserInfo {
      * and uniquely identifies the user across the entire system.
      */
     id: EntityId;
+    /**
+     * Represents the tenant associated with the current context.
+     * The value can either be a tenant-specific identifier (TenantSlug) or null if no tenant is assigned.
+     *
+     * A TenantSlug is typically a unique string or slug representing a tenant in multi-tenant applications.
+     * Null indicates the absence of a tenant in the current context.
+     *
+     * This variable is often used to scope application logic and data to a specific tenant.
+     */
+    tenant: TenantSlug | null;
     /**
      * The user's first name or given name.
      *