@equinor/fusion-framework-module-msal-node 4.1.0 → 4.1.2

package/dist/types/create-auth-cache.d.ts

@@ -1,15 +1,17 @@
-import { PersistenceCachePlugin, type IPersistence } from '@azure/msal-node-extensions';
 /**
  * Creates a persistence cache for storing authentication data securely on disk.
  *
  * The cache is encrypted and scoped to the current user for security. It is uniquely identified
  * by the provided tenant and client IDs, and is associated with the 'fusion-framework' service.
  *
+ * Requires `@azure/msal-node-extensions` to be installed (optional dependency).
+ * Only available in interactive desktop environments with a system keychain.
+ *
  * @param tenantId - The Azure AD tenant ID used to identify the cache.
  * @param clientId - The Azure AD client/application ID used to identify the cache.
  * @returns A promise that resolves to the created persistence cache instance.
  */
-export declare const createPersistenceCache: (tenantId: string, clientId: string) => Promise<IPersistence>;
+export declare const createPersistenceCache: (tenantId: string, clientId: string) => Promise<import("@azure/msal-node-extensions").IPersistence>;
 /**
  * Clears the persistence cache for a specific tenant and client.
  *
@@ -29,4 +31,4 @@ export declare const clearPersistenceCache: (tenantId: string, clientId: string)
  * @param clientId - The Azure AD client/application ID.
  * @returns A promise that resolves to an instance of `PersistenceCachePlugin`.
  */
-export declare const createPersistenceCachePlugin: (tenantId: string, clientId: string) => Promise<PersistenceCachePlugin>;
+export declare const createPersistenceCachePlugin: (tenantId: string, clientId: string) => Promise<import("@azure/msal-node-extensions").PersistenceCachePlugin>;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "4.1.0";
+export declare const version = "4.1.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-msal-node",
-  "version": "4.1.0",
+  "version": "4.1.2",
   "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",
@@ -34,12 +34,14 @@
   },
   "dependencies": {
     "@azure/msal-node": "^5.0.2",
-    "@azure/msal-node-extensions": "^5.0.2",
     "open": "^11.0.0",
-    "@equinor/fusion-framework-module": "^6.0.0"
+    "@equinor/fusion-framework-module": "^6.1.0"
+  },
+  "optionalDependencies": {
+    "@azure/msal-node-extensions": "^5.0.2"
   },
   "devDependencies": {
-    "typescript": "^5.9.3"
+    "typescript": "^6.0.3"
   },
   "scripts": {
     "build": "tsc -b"

package/src/create-auth-cache.ts

@@ -1,15 +1,22 @@
-import {
-  DataProtectionScope,
-  Environment,
-  PersistenceCreator,
-  PersistenceCachePlugin,
-  type IPersistence,
-} from '@azure/msal-node-extensions';
-
 import { tmpdir } from 'node:os';
-
 import path from 'node:path';
 
+const importMsalNodeExtensions = async (): Promise<
+  typeof import('@azure/msal-node-extensions')
+> => {
+  try {
+    return await import('@azure/msal-node-extensions');
+  } catch (cause) {
+    throw new Error(
+      'Failed to load @azure/msal-node-extensions. ' +
+        'Token cache persistence requires a native module (keytar/libsecret) that is only ' +
+        'available in interactive desktop environments. Install the optional dependency or ' +
+        'use a non-caching auth mode.',
+      { cause },
+    );
+  }
+};
+
 /**
  * Resolves the directory path for storing the authentication cache.
  *
@@ -17,7 +24,8 @@ import path from 'node:path';
  *
  * @returns The resolved cache directory path as a string.
  */
-const resolveCachePath = () => {
+const resolveCachePath = async (): Promise<string> => {
+  const { Environment } = await importMsalNodeExtensions();
   return Environment?.getUserRootDirectory() ?? tmpdir();
 };
 
@@ -28,8 +36,8 @@ const resolveCachePath = () => {
  * @param clientId - The Azure AD client/application ID.
  * @returns The full file path for the cache file.
  */
-const resolveCacheFilePath = (tenantId: string, clientId: string) => {
-  return path.join(resolveCachePath(), `.token-cache-${tenantId}_${clientId}`);
+const resolveCacheFilePath = async (tenantId: string, clientId: string): Promise<string> => {
+  return path.join(await resolveCachePath(), `.token-cache-${tenantId}_${clientId}`);
 };
 
 /**
@@ -38,16 +46,17 @@ const resolveCacheFilePath = (tenantId: string, clientId: string) => {
  * The cache is encrypted and scoped to the current user for security. It is uniquely identified
  * by the provided tenant and client IDs, and is associated with the 'fusion-framework' service.
  *
+ * Requires `@azure/msal-node-extensions` to be installed (optional dependency).
+ * Only available in interactive desktop environments with a system keychain.
+ *
  * @param tenantId - The Azure AD tenant ID used to identify the cache.
  * @param clientId - The Azure AD client/application ID used to identify the cache.
  * @returns A promise that resolves to the created persistence cache instance.
  */
-export const createPersistenceCache = async (
-  tenantId: string,
-  clientId: string,
-): Promise<IPersistence> => {
+export const createPersistenceCache = async (tenantId: string, clientId: string) => {
+  const { DataProtectionScope, PersistenceCreator } = await importMsalNodeExtensions();
   return PersistenceCreator.createPersistence({
-    cachePath: resolveCacheFilePath(tenantId, clientId),
+    cachePath: await resolveCacheFilePath(tenantId, clientId),
     serviceName: 'fusion-framework',
     accountName: [tenantId, clientId].join('_'),
     dataProtectionScope: DataProtectionScope.CurrentUser,
@@ -77,9 +86,7 @@ export const clearPersistenceCache = async (tenantId: string, clientId: string):
  * @param clientId - The Azure AD client/application ID.
  * @returns A promise that resolves to an instance of `PersistenceCachePlugin`.
  */
-export const createPersistenceCachePlugin = async (
-  tenantId: string,
-  clientId: string,
-): Promise<PersistenceCachePlugin> => {
+export const createPersistenceCachePlugin = async (tenantId: string, clientId: string) => {
+  const { PersistenceCachePlugin } = await importMsalNodeExtensions();
   return new PersistenceCachePlugin(await createPersistenceCache(tenantId, clientId));
 };

package/src/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '4.1.0';
+export const version = '4.1.2';