@hichchi/ngx-auth 0.0.2 → 0.0.4

package/package.json

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

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

@@ -17,6 +17,8 @@ import * as i4 from '@hichchi/ngx-ui';
 interface AuthConfig {
     authField?: AuthField;
     apiBaseURL: string;
+    splitDomain?: string;
+    devSubdomain?: string;
 }
 
 /**
@@ -1258,6 +1260,13 @@ declare class AuthService extends CrudHttpService {
  * The module must be configured using the forRoot() method to provide the necessary
  * authentication configuration.
  *
+ * API base URL handling:
+ * - `apiBaseURL` defines the base API host for auth requests.
+ * - Optional `prependSubdomain` lets you prepend a subdomain to `apiBaseURL`.
+ *   - `string`: uses the provided subdomain
+ *   - `true`: resolves subdomain dynamically from the current host context
+ *   - `false` / `undefined`: keeps `apiBaseURL` unchanged
+ *
  * @example
  * ```typescript
  * // Basic module configuration
@@ -1285,6 +1294,34 @@ declare class AuthService extends CrudHttpService {
  * export class AppModule { }
  * ```
  *
+ * @example
+ * ```typescript
+ * // Configuration with a static subdomain
+ * @NgModule({
+ *   imports: [
+ *     NgxHichchiAuthModule.forRoot({
+ *       apiBaseURL: 'https://api.example.com',
+ *       prependSubdomain: 'tenant-a'
+ *     })
+ *   ]
+ * })
+ * export class AppModule { }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Configuration with dynamic subdomain resolution
+ * @NgModule({
+ *   imports: [
+ *     NgxHichchiAuthModule.forRoot({
+ *       apiBaseURL: 'https://api.example.com',
+ *       prependSubdomain: true
+ *     })
+ *   ]
+ * })
+ * 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,8 +1332,15 @@ 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. Before providers are created, `apiBaseURL` is normalized
+     * through `prependSubdomainToApi(config.apiBaseURL, config.prependSubdomain)`.
+     * It then provides the AuthService and authentication configuration token required
+     * for the module to function properly.
+     *
+     * `prependSubdomain` behavior:
+     * - `string`: prepend that subdomain to the API host
+     * - `true`: derive subdomain dynamically from the current host context
+     * - `false` / `undefined`: do not prepend a subdomain
      *
      * @param config - The authentication configuration object containing API endpoints and settings
      * @returns A ModuleWithProviders object configured with authentication providers
@@ -1318,9 +1362,28 @@ declare class NgxHichchiAuthModule {
      * })
      * ```
      *
+     * @example
+     * ```typescript
+     * // Static subdomain
+     * NgxHichchiAuthModule.forRoot({
+     *   apiBaseURL: 'https://api.example.com',
+     *   prependSubdomain: 'tenant-a'
+     * })
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Dynamic subdomain
+     * NgxHichchiAuthModule.forRoot({
+     *   apiBaseURL: 'https://api.example.com',
+     *   prependSubdomain: true
+     * })
+     * ```
+     *
      * @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 prependSubdomainToUrlBrowser} Utility used to transform `apiBaseURL`
      */
     static forRoot(config: AuthConfig): ModuleWithProviders<NgxHichchiAuthModule>;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgxHichchiAuthModule, never>;