@hichchi/nest-connector 0.0.7 → 0.0.8

package/auth.cjs.js

@@ -33,7 +33,27 @@ var error_responses = require('./error.responses.cjs.js');
  * }
  * ```
  */
-const TENANT_HEADER_KEY = "x-tenant";
+const HEADER_TENANT_KEY = "x-tenant";
+/**
+ * Header key for tenant identifier propagation.
+ *
+ * This constant defines the HTTP header used to pass a stable tenant identifier
+ * (for example, an internal ID or UUID) in requests across services.
+ *
+ * Use this key when your auth/tenant resolution flow depends on tenant IDs
+ * rather than tenant names or slugs.
+ *
+ * @example
+ * ```typescript
+ * // Extract tenant ID from request headers in a guard/controller
+ * const tenantId = req.header(HEADER_TENANT_ID_KEY);
+ *
+ * if (!tenantId) {
+ *   throw new UnauthorizedException("Missing tenant id header");
+ * }
+ * ```
+ */
+const HEADER_TENANT_ID_KEY = "x-tenant-id";
 
 /**
  * Authentication Endpoints Enum
@@ -1325,5 +1345,6 @@ function isRoleObject(role) {
 
 exports.AuthErrors = AuthErrors;
 exports.AuthSuccessResponses = AuthSuccessResponses;
-exports.TENANT_HEADER_KEY = TENANT_HEADER_KEY;
+exports.HEADER_TENANT_ID_KEY = HEADER_TENANT_ID_KEY;
+exports.HEADER_TENANT_KEY = HEADER_TENANT_KEY;
 exports.isRoleObject = isRoleObject;

package/auth.esm.js

@@ -31,7 +31,27 @@ import { e as HttpServerErrorStatus, H as HttpClientErrorStatus, f as HttpSucces
  * }
  * ```
  */
-const TENANT_HEADER_KEY = "x-tenant";
+const HEADER_TENANT_KEY = "x-tenant";
+/**
+ * Header key for tenant identifier propagation.
+ *
+ * This constant defines the HTTP header used to pass a stable tenant identifier
+ * (for example, an internal ID or UUID) in requests across services.
+ *
+ * Use this key when your auth/tenant resolution flow depends on tenant IDs
+ * rather than tenant names or slugs.
+ *
+ * @example
+ * ```typescript
+ * // Extract tenant ID from request headers in a guard/controller
+ * const tenantId = req.header(HEADER_TENANT_ID_KEY);
+ *
+ * if (!tenantId) {
+ *   throw new UnauthorizedException("Missing tenant id header");
+ * }
+ * ```
+ */
+const HEADER_TENANT_ID_KEY = "x-tenant-id";
 
 /**
  * Authentication Endpoints Enum
@@ -1321,4 +1341,4 @@ function isRoleObject(role) {
   return Boolean(role) && typeof role === "object" && Boolean("name" in role);
 }
 
-export { AuthEndpoint, AuthErrorResponseCode, AuthErrors, AuthField, AuthMethod, AuthProvider, AuthStrategy, AuthSuccessResponseCode, AuthSuccessResponses, TENANT_HEADER_KEY, isRoleObject };
+export { AuthEndpoint, AuthErrorResponseCode, AuthErrors, AuthField, AuthMethod, AuthProvider, AuthStrategy, AuthSuccessResponseCode, AuthSuccessResponses, HEADER_TENANT_ID_KEY, HEADER_TENANT_KEY, isRoleObject };

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.7",
+  "version": "0.0.8",
   "publishConfig": {
     "access": "public"
   },

package/readme-top.md

@@ -112,6 +112,11 @@ npm install class-validator class-transformer
 - 📊 **Status Code Management** - Organized HTTP status code handling
 - 🔧 **Type-Safe Responses** - Full TypeScript support for response structures
 
+### 🔐 Authentication Interfaces
+- 👤 **Typed Auth User Interface** - Generic `User<Role, Permission, Tenant>` typing for role/permission/tenant-aware authentication flows
+- 🏢 **Tenant Interface Support** - Dedicated tenant interfaces with owner/member user relationships for multi-tenant domains
+- 🧩 **Composed Auth Models** - Consistent `Role`, `User`, and `Tenant` interface exports for shared contracts across services
+
 ### 🎨 Developer Experience
 - 📝 **Comprehensive Documentation** - Detailed JSDoc comments for all interfaces
 - 🔍 **IntelliSense Support** - Full IDE autocomplete and type checking
@@ -120,6 +125,7 @@ npm install class-validator class-transformer
 
 ### 🔧 Advanced Features
 - 🏷️ **User Info Interfaces** - Standardized user information structures
+- 🔀 **Clear Context Separation** - Base `UserInfo` for identity data, auth `User` interface for tenant-aware authentication context
 - 📦 **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

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

@@ -29,4 +29,24 @@
  * }
  * ```
  */
-export declare const TENANT_HEADER_KEY = "x-tenant";
+export declare const HEADER_TENANT_KEY = "x-tenant";
+/**
+ * Header key for tenant identifier propagation.
+ *
+ * This constant defines the HTTP header used to pass a stable tenant identifier
+ * (for example, an internal ID or UUID) in requests across services.
+ *
+ * Use this key when your auth/tenant resolution flow depends on tenant IDs
+ * rather than tenant names or slugs.
+ *
+ * @example
+ * ```typescript
+ * // Extract tenant ID from request headers in a guard/controller
+ * const tenantId = req.header(HEADER_TENANT_ID_KEY);
+ *
+ * if (!tenantId) {
+ *   throw new UnauthorizedException("Missing tenant id header");
+ * }
+ * ```
+ */
+export declare const HEADER_TENANT_ID_KEY = "x-tenant-id";

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

@@ -1,6 +1,7 @@
 export * from "./dtos";
 export * from "./google-profile.interface";
 export * from "./role.interface";
+export * from "./tenant.interface";
 export * from "./user.interface";
 export * from "./tokens.interface";
 export * from "./response.interfaces";

package/src/auth/interfaces/role.interface.d.ts

@@ -1,5 +1,6 @@
-import { Model } from "../../crud";
+import { EntityId, Model } from "../../crud";
 import { User } from "./user.interface";
+import { Tenant } from "./tenant.interface";
 export interface RoleBase<R extends string = string, P extends string = string> {
     /**
      * Human-readable name of the role.
@@ -42,5 +43,7 @@ export interface RoleBase<R extends string = string, P extends string = string>
  * @see {@link User} Interface for user information which references roles
  */
 export interface Role<R extends string = string, P extends string = string> extends RoleBase<R, P>, Model {
+    tenant?: Tenant | null;
+    tenantId?: EntityId | null;
     users: User<R, P>[] | null;
 }

package/src/auth/interfaces/tenant.interface.d.ts

@@ -0,0 +1,60 @@
+import { EntityId, Model } from "../../crud";
+import { Role, TenantSlug } from "../auth";
+import { User } from "./user.interface";
+/**
+ * Base interface defining core tenant identity properties.
+ *
+ * This interface contains the minimum identifying information needed to
+ * represent a tenant in a multi-tenant system.
+ */
+export interface TenantBase {
+    /**
+     * Human-readable tenant name.
+     *
+     * This value is typically displayed in administrative interfaces and
+     * organization selectors.
+     */
+    name: string;
+    /**
+     * Unique slug used to identify the tenant in routes and context resolution.
+     *
+     * The slug should be stable and URL-friendly to support tenant-specific
+     * API and frontend paths.
+     */
+    slug: TenantSlug;
+}
+/**
+ * Interface representing a tenant entity in the authentication domain.
+ *
+ * Extends {@link TenantBase} with persistence fields from {@link Model} and
+ * ownership/member relationships to users.
+ *
+ * @interface Tenant
+ *
+ * @see {@link User} Interface for user information linked to tenants
+ */
+export interface Tenant extends TenantBase, Model {
+    /**
+     * User who owns and manages the tenant.
+     *
+     * This value may be null when ownership has not been assigned yet.
+     */
+    owner: User | null;
+    /**
+     * ID of the user who owns and manages the tenant.
+     */
+    ownerId: EntityId | null;
+    /**
+     * Represents the roles associated with a user or entity.
+     * This can either be an array of Role objects or null if no roles are assigned.
+     *
+     * @type {Role[] | null}
+     */
+    roles: Role[] | null;
+    /**
+     * Users associated with this tenant.
+     *
+     * Contains the members that belong to the tenant context.
+     */
+    users: User[] | null;
+}

package/src/auth/interfaces/user.interface.d.ts

@@ -3,6 +3,8 @@ import { Role } from "./role.interface";
 import { AuthProvider } from "../enums";
 import { EntityId, Model } from "../../crud";
 import { GoogleProfile } from "./google-profile.interface";
+import { TenantSlug } from "../types";
+import { Tenant } from "./tenant.interface";
 /**
  * Interface representing a user account in the authentication system.
  *
@@ -23,7 +25,7 @@ import { GoogleProfile } from "./google-profile.interface";
  * @see {@link Role} Interface defining user authorization roles
  * @see {@link AuthResponse} Authentication response containing user information
  */
-export interface User<R extends string = string, P extends string = string> extends UserInfo, Model {
+export interface User<R extends string = string, P extends string = string, T extends string = TenantSlug> extends UserInfo, Model {
     /**
      * The user's email address.
      *
@@ -80,6 +82,22 @@ export interface User<R extends string = string, P extends string = string> exte
      * @see {@link Role} Interface defining user authorization roles
      */
     roleId?: EntityId | null;
+    /**
+     * Tenant associated with the user account.
+     *
+     * Supports either a full tenant object or a tenant slug identifier,
+     * depending on whether tenant relations are loaded.
+     *
+     * @see {@link Tenant} Interface defining tenant details
+     */
+    tenant: Tenant | T | null;
+    /**
+     * The unique identifier of the user's tenant.
+     *
+     * Optional foreign key reference to the tenant entity. This can be used
+     * for efficient tenant scoping without loading the full tenant object.
+     */
+    tenantId?: EntityId | null;
     /**
      * Indicates whether the user's email address has been verified.
      *

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

@@ -1,4 +1,3 @@
-import { TenantSlug } from "../../auth";
 import { EntityId } from "../../crud";
 /**
  * Interface representing essential user information.
@@ -41,16 +40,6 @@ 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.
      *

package/src/crud/types/types.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Primitive type
+ */
+type Primitive = string | number | boolean | bigint | symbol | null | undefined;
 /**
  * Entity ID type
  *
@@ -31,5 +35,6 @@ export type EntityDeepPartial<T> = T extends Array<infer _U> ? never : T extends
 export type QueryDeepPartial<T extends {
     [P in keyof T]: unknown;
 } = object> = {
-    [P in keyof T]?: T[P] extends Date ? never : T[P] extends (infer U)[] ? U extends object ? never : T[P] : T[P] extends object ? T[P] | T[P][] : QueryDeepPartial<T[P]>;
+    [P in keyof T]?: T[P] extends Date ? never : T[P] extends (infer U)[] ? U extends object ? never : T[P] : T[P] extends Primitive ? T[P] | T[P][] : QueryDeepPartial<T[P]>;
 };
+export {};