@hichchi/nest-connector 0.0.4 → 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
  *
@@ -1292,4 +1325,5 @@ function isRoleObject(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
  *
@@ -1288,4 +1321,4 @@ function isRoleObject(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/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.4",
+  "version": "0.0.5",
   "publishConfig": {
     "access": "public"
   },

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.
      *