@hichchi/ngx-auth 0.0.3 → 0.0.5

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hichchi/ngx-auth",
   "description": "A utility library for Angular applications with common services, interceptors, and state management",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "publishConfig": {
     "access": "public"
   },
@@ -19,10 +19,10 @@
     "@angular/core": "^21.1.4",
     "@angular/forms": "^21.1.4",
     "@angular/router": "^21.1.4",
-    "@hichchi/nest-connector": "0.0.3",
-    "@hichchi/ngx-ui": "0.0.3",
-    "@hichchi/ngx-utils": "0.0.3",
-    "@hichchi/utils": "0.0.3",
+    "@hichchi/nest-connector": "0.0.5",
+    "@hichchi/ngx-ui": "0.0.5",
+    "@hichchi/ngx-utils": "0.0.5",
+    "@hichchi/utils": "0.0.5",
     "@ngrx/signals": "^21.0.1",
     "rxjs": "^7.8.2"
   },

package/types/hichchi-ngx-auth.d.ts

@@ -4,7 +4,7 @@ import { ErrorResponseCode, SuccessResponse } from '@hichchi/nest-connector';
 import * as rxjs from 'rxjs';
 import { Observable } from 'rxjs';
 import * as _hichchi_nest_connector_auth from '@hichchi/nest-connector/auth';
-import { AuthField, AuthResponse, User, SignInBody, SignUpBody, AccessToken, RefreshToken, TokenResponse } from '@hichchi/nest-connector/auth';
+import { AuthField, TenantSlug, AuthResponse, User, SignInBody, SignUpBody, AccessToken, RefreshToken, TokenResponse } from '@hichchi/nest-connector/auth';
 import * as _angular_core from '@angular/core';
 import { InputSignal, OutputEmitterRef, WritableSignal, Signal, ModuleWithProviders } from '@angular/core';
 import { HttpError, DataFormGroup, CrudHttpService } from '@hichchi/ngx-utils';
@@ -17,6 +17,8 @@ import * as i4 from '@hichchi/ngx-ui';
 interface AuthConfig {
     authField?: AuthField;
     apiBaseURL: string;
+    splitDomain?: string;
+    tenant?: TenantSlug;
 }
 
 /**
@@ -1258,6 +1260,11 @@ declare class AuthService extends CrudHttpService {
  * The module must be configured using the forRoot() method to provide the necessary
  * authentication configuration.
  *
+ * Tenant handling:
+ * - `tenant` can be provided in the configuration or dynamically set in requests
+ *   via a custom HTTP header (`x-tenant`, controlled by `TENANT_HEADER_KEY`).
+ * - This approach replaces previous subdomain-based tenant resolution.
+ *
  * @example
  * ```typescript
  * // Basic module configuration
@@ -1285,6 +1292,20 @@ declare class AuthService extends CrudHttpService {
  * export class AppModule { }
  * ```
  *
+ * @example
+ * ```typescript
+ * // Optional static tenant header
+ * @NgModule({
+ *   imports: [
+ *     NgxHichchiAuthModule.forRoot({
+ *       apiBaseURL: 'https://api.example.com',
+ *       tenant: 'tenant-a'
+ *     })
+ *   ]
+ * })
+ * export class AppModule { }
+ * ```
+ *
  * @see {@link AuthConfig} Configuration interface for the authentication module
  * @see {@link AuthFormComponent} Authentication form component
  * @see {@link PermissionDirective} Permission-based conditional rendering directive
@@ -1295,10 +1316,11 @@ declare class NgxHichchiAuthModule {
      * Configures the NgxHichchiAuthModule with the provided authentication configuration
      *
      * This static method sets up the module with the necessary providers and configuration
-     * for authentication functionality. It provides the AuthService, HTTP client, and
-     * authentication configuration token that are required for the module to function properly.
+     * for authentication functionality. The configuration includes the `apiBaseURL` for
+     * all authentication requests, and optionally a `tenant` string that is attached
+     * to requests via the `TENANT_HEADER_KEY` header.
      *
-     * @param config - The authentication configuration object containing API endpoints and settings
+     * @param config - The authentication configuration object containing API endpoints, tenant, and other settings
      * @returns A ModuleWithProviders object configured with authentication providers
      *
      * @example
@@ -1318,9 +1340,19 @@ declare class NgxHichchiAuthModule {
      * })
      * ```
      *
+     * @example
+     * ```typescript
+     * // Configuration with static tenant
+     * NgxHichchiAuthModule.forRoot({
+     *   apiBaseURL: 'https://api.example.com',
+     *   tenant: 'tenant-a'
+     * })
+     * ```
+     *
      * @see {@link AuthConfig} Interface defining the configuration structure
      * @see {@link AUTH_CONFIG} Injection token for the authentication configuration
      * @see {@link AuthService} Service that uses the provided configuration
+     * @see {@link TENANT_HEADER_KEY} Constant used to attach tenant header to requests
      */
     static forRoot(config: AuthConfig): ModuleWithProviders<NgxHichchiAuthModule>;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgxHichchiAuthModule, never>;