@equinor/fusion-framework-module-msal-node 3.0.2-next.0 → 4.0.0

package/dist/types/AuthConfigurator.d.ts

@@ -14,11 +14,50 @@ import type { AuthConfig } from './AuthConfigurator.interface.js';
  */
 export declare class AuthConfigurator extends BaseConfigBuilder<AuthConfig> {
     constructor();
+    /**
+     * Sets the authentication mode for the module.
+     *
+     * @param mode - The authentication mode: `'interactive'`, `'silent'`, or `'token_only'`.
+     */
     setMode(mode: AuthConfig['mode']): void;
+    /**
+     * Sets a pre-configured MSAL `PublicClientApplication` instance.
+     *
+     * Use this when you need full control over the MSAL client configuration.
+     * For most cases, prefer {@link AuthConfigurator.setClientConfig | setClientConfig}.
+     *
+     * @param client - The MSAL `PublicClientApplication` instance.
+     */
     setClient(client: AuthConfig['client']): void;
+    /**
+     * Configures the MSAL client using Azure AD tenant and client IDs.
+     *
+     * Lazily creates a `PublicClientApplication` with a secure persistence cache.
+     * The dynamic import avoids requiring `libsecret` in environments that do not need it.
+     *
+     * @param tenantId - Azure AD tenant (directory) ID.
+     * @param clientId - Azure AD application (client) ID.
+     */
     setClientConfig(tenantId: string, clientId: string): void;
+    /**
+     * Sets the port for the local HTTP callback server used in interactive mode.
+     *
+     * @param port - Port number for the local server.
+     */
     setServerPort(port: number): void;
+    /**
+     * Sets a callback invoked when the login URL is ready in interactive mode.
+     *
+     * Use this to display or log the authentication URL for the user.
+     *
+     * @param onOpen - Callback receiving the authentication URL, or `undefined` to disable.
+     */
     setServerOnOpen(onOpen: ((url: string) => void) | undefined): void;
+    /**
+     * Sets a pre-obtained access token for `token_only` mode.
+     *
+     * @param token - The static access token string.
+     */
     setAccessToken(token: string): void;
     /**
      * Prepares and finalizes the authentication configuration before validation and use.

package/dist/types/index.d.ts

@@ -1,3 +1,24 @@
+/**
+ * `@equinor/fusion-framework-module-msal-node` provides Azure AD authentication
+ * for Node.js applications using Microsoft's MSAL library.
+ *
+ * Supports three authentication modes:
+ * - **interactive** — browser-based login with a local callback server (CLI tools, development)
+ * - **silent** — cached credential reuse without user interaction (background services)
+ * - **token_only** — static pre-obtained token passthrough (CI/CD, automation)
+ *
+ * @example
+ * ```typescript
+ * import { enableAuthModule } from '@equinor/fusion-framework-module-msal-node';
+ *
+ * enableAuthModule(configurator, (builder) => {
+ *   builder.setMode('interactive');
+ *   builder.setClientConfig('your-tenant-id', 'your-client-id');
+ * });
+ * ```
+ *
+ * @packageDocumentation
+ */
 export { AuthProvider } from './AuthProvider.js';
 export type { IAuthProvider } from './AuthProvider.interface.js';
 export type { IAuthConfigurator, AuthConfig } from './AuthConfigurator.interface.js';

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "3.0.2-next.0";
+export declare const version = "4.0.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-msal-node",
-  "version": "3.0.2-next.0",
+  "version": "4.0.0",
   "description": "Fusion Framework module for secure Azure AD authentication in Node.js using MSAL. Supports interactive, silent, and token-only authentication modes with encrypted token storage.",
   "type": "module",
   "main": "dist/esm/index.js",
@@ -36,10 +36,10 @@
     "@azure/msal-node": "^5.0.2",
     "@azure/msal-node-extensions": "^5.0.2",
     "open": "^11.0.0",
-    "@equinor/fusion-framework-module": "^5.0.7-next.0"
+    "@equinor/fusion-framework-module": "^6.0.0"
   },
   "devDependencies": {
-    "typescript": "^5.8.2"
+    "typescript": "^5.9.3"
   },
   "scripts": {
     "build": "tsc -b"

package/src/AuthConfigurator.ts

@@ -26,14 +26,36 @@ export class AuthConfigurator extends BaseConfigBuilder<AuthConfig> {
     this.setMode('interactive');
   }
 
+  /**
+   * Sets the authentication mode for the module.
+   *
+   * @param mode - The authentication mode: `'interactive'`, `'silent'`, or `'token_only'`.
+   */
   setMode(mode: AuthConfig['mode']) {
     this._set('mode', mode);
   }
 
+  /**
+   * Sets a pre-configured MSAL `PublicClientApplication` instance.
+   *
+   * Use this when you need full control over the MSAL client configuration.
+   * For most cases, prefer {@link AuthConfigurator.setClientConfig | setClientConfig}.
+   *
+   * @param client - The MSAL `PublicClientApplication` instance.
+   */
   setClient(client: AuthConfig['client']) {
     this._set('client', client);
   }
 
+  /**
+   * Configures the MSAL client using Azure AD tenant and client IDs.
+   *
+   * Lazily creates a `PublicClientApplication` with a secure persistence cache.
+   * The dynamic import avoids requiring `libsecret` in environments that do not need it.
+   *
+   * @param tenantId - Azure AD tenant (directory) ID.
+   * @param clientId - Azure AD application (client) ID.
+   */
   setClientConfig(tenantId: string, clientId: string): void {
     this._set('client', async () => {
       // Dynamically import the createAuthClient function since the client uses `libsecret``
@@ -44,14 +66,31 @@ export class AuthConfigurator extends BaseConfigBuilder<AuthConfig> {
     });
   }
 
+  /**
+   * Sets the port for the local HTTP callback server used in interactive mode.
+   *
+   * @param port - Port number for the local server.
+   */
   setServerPort(port: number) {
     this._set('server.port', port);
   }
 
+  /**
+   * Sets a callback invoked when the login URL is ready in interactive mode.
+   *
+   * Use this to display or log the authentication URL for the user.
+   *
+   * @param onOpen - Callback receiving the authentication URL, or `undefined` to disable.
+   */
   setServerOnOpen(onOpen: ((url: string) => void) | undefined) {
     this._set('server.onOpen', onOpen);
   }
 
+  /**
+   * Sets a pre-obtained access token for `token_only` mode.
+   *
+   * @param token - The static access token string.
+   */
   setAccessToken(token: string) {
     this._set('accessToken', token);
   }

package/src/index.ts

@@ -1,3 +1,25 @@
+/**
+ * `@equinor/fusion-framework-module-msal-node` provides Azure AD authentication
+ * for Node.js applications using Microsoft's MSAL library.
+ *
+ * Supports three authentication modes:
+ * - **interactive** — browser-based login with a local callback server (CLI tools, development)
+ * - **silent** — cached credential reuse without user interaction (background services)
+ * - **token_only** — static pre-obtained token passthrough (CI/CD, automation)
+ *
+ * @example
+ * ```typescript
+ * import { enableAuthModule } from '@equinor/fusion-framework-module-msal-node';
+ *
+ * enableAuthModule(configurator, (builder) => {
+ *   builder.setMode('interactive');
+ *   builder.setClientConfig('your-tenant-id', 'your-client-id');
+ * });
+ * ```
+ *
+ * @packageDocumentation
+ */
+
 export { AuthProvider } from './AuthProvider.js';
 
 export type { IAuthProvider } from './AuthProvider.interface.js';

package/src/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '3.0.2-next.0';
+export const version = '4.0.0';