chore: coderabbit-comments

Author: ryanbas21

e2e/am-mock-api/package.json

@@ -16,6 +16,6 @@
     "uuid": "^13.0.0"
   },
   "devDependencies": {
-    "@types/express": "^4.17.17"
+    "@types/express": "^5.0.0"
   }
 }

packages/journey-client/package.json

@@ -29,9 +29,7 @@
     "@forgerock/sdk-utilities": "workspace:*",
     "@forgerock/storage": "workspace:*",
     "@reduxjs/toolkit": "catalog:",
-    "tslib": "^2.3.0",
-    "vite": "catalog:vite",
-    "vitest-canvas-mock": "catalog:vitest"
+    "tslib": "^2.3.0"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "catalog:vitest",

packages/journey-client/src/lib/config.types.ts

@@ -8,89 +8,35 @@
 import type { BaseConfig, WellKnownResponse, PathsConfig } from '@forgerock/sdk-types';
 import type { RequestMiddleware } from '@forgerock/sdk-request-middleware';
 
-/**
- * Standard journey client configuration with explicit baseUrl.
- *
- * Use this when you want to configure the AM server directly without
- * OIDC well-known endpoint discovery.
- *
- * @example
- * ```typescript
- * const config: JourneyClientConfig = {
- *   serverConfig: {
- *     baseUrl: 'https://am.example.com/am/',
- *   },
- *   realmPath: 'alpha',
- * };
- * ```
- */
+export interface JourneyServerConfig {
+  baseUrl: string;
+  paths?: PathsConfig['paths'];
+  timeout?: number;
+}
+
 export interface JourneyClientConfig extends BaseConfig {
+  serverConfig: JourneyServerConfig;
   middleware?: Array<RequestMiddleware>;
   realmPath?: string;
 }
 
-/**
- * Server configuration that includes well-known OIDC endpoint discovery.
- *
- * When wellknown is provided, the client will fetch the OIDC discovery
- * document to obtain endpoints like authorization, token, userinfo, etc.
- *
- * Note: baseUrl is still required for AM-specific endpoints (authenticate,
- * sessions) which are not part of the standard OIDC well-known response.
- */
 export interface WellknownServerConfig {
-  /** Base URL for AM-specific endpoints (authenticate, sessions) */
   baseUrl: string;
-  /** URL to the OIDC well-known configuration endpoint */
   wellknown: string;
-  /** Custom path overrides for endpoints */
   paths?: PathsConfig['paths'];
-  /** Request timeout in milliseconds */
   timeout?: number;
 }
 
-/**
- * Journey client configuration with OIDC well-known endpoint discovery.
- *
- * This configuration fetches the OIDC discovery document to obtain
- * standard OIDC endpoints while still using baseUrl for AM-specific
- * journey endpoints.
- *
- * @example
- * ```typescript
- * const config: AsyncJourneyClientConfig = {
- *   serverConfig: {
- *     baseUrl: 'https://am.example.com/am/',
- *     wellknown: 'https://am.example.com/am/oauth2/realms/root/realms/alpha/.well-known/openid-configuration',
- *   },
- *   // realmPath is optional - can be inferred from the well-known issuer
- * };
- * ```
- */
 export interface AsyncJourneyClientConfig {
   serverConfig: WellknownServerConfig;
   middleware?: Array<RequestMiddleware>;
-  /** Optional realm path - can be inferred from well-known issuer if not provided */
   realmPath?: string;
 }
 
-/**
- * Internal configuration type that includes the resolved well-known response.
- *
- * This type is used internally after the well-known endpoint has been fetched
- * and the configuration has been normalized.
- */
 export interface InternalJourneyClientConfig extends JourneyClientConfig {
-  /** The fetched OIDC well-known response, if wellknown discovery was used */
   wellknownResponse?: WellKnownResponse;
 }
 
-/**
- * Union type for journey client initialization.
- *
- * Accepts either a standard configuration with baseUrl only,
- * or an async configuration with well-known endpoint discovery.
- */
 export type JourneyConfigInput = JourneyClientConfig | AsyncJourneyClientConfig;
 
 export type { RequestMiddleware };

packages/journey-client/src/lib/interfaces.ts

@@ -5,20 +5,19 @@
  * of the MIT license. See the LICENSE file for details.
  */
 
-import { JourneyClientConfig } from './config.types.js';
 import { JourneyStep } from './step.types.js';
 
-export interface StartParam extends JourneyClientConfig {
+export interface StartParam {
   journey: string;
   query?: Record<string, string>;
 }
 
-export interface ResumeOptions extends JourneyClientConfig {
+export interface ResumeOptions {
   journey?: string;
   query?: Record<string, string>;
 }
 
-export interface NextOptions extends JourneyClientConfig {
+export interface NextOptions {
   query?: Record<string, string>;
 }
 

packages/journey-client/src/lib/wellknown.utils.ts

@@ -5,101 +5,45 @@
  * of the MIT license. See the LICENSE file for details.
  */
 
-// Re-export error handling from sdk-oidc (uses RTK Query types)
 export { createWellknownError } from '@forgerock/sdk-oidc';
-
-// Re-export URL validation from sdk-utilities (pure utility)
 export { isValidWellknownUrl } from '@forgerock/sdk-utilities';
 
 import type { AsyncJourneyClientConfig, JourneyConfigInput } from './config.types.js';
 
+const REALM_PATTERNS = [
+  /\/oauth2\/realms\/root\/realms\/(.+)$/, // Legacy subrealm: /oauth2/realms/root/realms/{realm}
+  /\/oauth2\/realms\/(root)$/, // Legacy root: /oauth2/realms/root
+  /\/oauth2\/([^/]+)$/, // Simplified: /oauth2/{realm}
+] as const;
+
 /**
- * Attempts to infer the realm path from a ForgeRock AM issuer URL.
- *
- * AM issuer URLs follow one of two patterns:
- * - Simplified: `https://{host}/am/oauth2/{realm}` (e.g., `/am/oauth2/alpha`)
- * - Legacy: `https://{host}/am/oauth2/realms/root/realms/{realm}`
- *
- * This function extracts the realm from either format.
- * Returns undefined for non-AM issuers (e.g., PingOne, generic OIDC).
- *
- * @param issuer - The issuer URL from the well-known response
- * @returns The inferred realm path, or undefined if it cannot be determined
- *
- * @example
- * ```typescript
- * // Simplified format (common in ForgeBlocks)
- * inferRealmFromIssuer('https://openam-sdks.forgeblocks.com/am/oauth2/alpha')
- * // Returns: 'alpha'
- *
- * // Legacy format with explicit realm path
- * inferRealmFromIssuer('https://am.example.com/am/oauth2/realms/root/realms/alpha')
- * // Returns: 'alpha'
- *
- * // Nested subrealm (legacy format)
- * inferRealmFromIssuer('https://am.example.com/am/oauth2/realms/root/realms/customers/realms/premium')
- * // Returns: 'customers/realms/premium'
- *
- * // Non-AM issuer (e.g., PingOne)
- * inferRealmFromIssuer('https://auth.pingone.com/env-id/as')
- * // Returns: undefined
- * ```
+ * Infers the realm path from a ForgeRock AM issuer URL.
+ * Returns undefined for non-AM issuers.
  */
 export function inferRealmFromIssuer(issuer: string): string | undefined {
   try {
-    const url = new URL(issuer);
-    const pathname = url.pathname;
-
-    // Pattern 1: Legacy subrealm - /oauth2/realms/root/realms/{subrealm}
-    const legacySubRealmMatch = pathname.match(/\/oauth2\/realms\/root\/realms\/(.+)$/);
-    if (legacySubRealmMatch) {
-      return legacySubRealmMatch[1];
-    }
-
-    // Pattern 2: Legacy root realm - /oauth2/realms/root
-    const legacyRootMatch = pathname.match(/\/oauth2\/realms\/(root)$/);
-    if (legacyRootMatch) {
-      return legacyRootMatch[1];
-    }
-
-    // Pattern 3: Simplified format - /oauth2/{realm} (e.g., /am/oauth2/alpha)
-    const simplifiedMatch = pathname.match(/\/oauth2\/([^/]+)$/);
-    if (simplifiedMatch) {
-      return simplifiedMatch[1];
+    const pathname = new URL(issuer).pathname;
+    for (const pattern of REALM_PATTERNS) {
+      const match = pathname.match(pattern);
+      if (match) return match[1];
     }
-
     return undefined;
   } catch {
     return undefined;
   }
 }
 
 /**
- * Type guard to determine if the configuration includes well-known endpoint discovery.
- *
- * @param config - The journey client configuration (union of sync and async configs)
- * @returns True if the config has a wellknown property in serverConfig
- *
- * @example
- * ```typescript
- * const config: JourneyConfigInput = {
- *   serverConfig: {
- *     baseUrl: 'https://am.example.com/am/',
- *     wellknown: 'https://am.example.com/am/oauth2/realms/root/realms/alpha/.well-known/openid-configuration'
- *   }
- * };
- *
- * if (hasWellknownConfig(config)) {
- *   // TypeScript now knows config is AsyncJourneyClientConfig
- *   const wellknownUrl = config.serverConfig.wellknown;
- * }
- * ```
+ * Type guard to check if config uses well-known endpoint discovery.
  */
 export function hasWellknownConfig(config: JourneyConfigInput): config is AsyncJourneyClientConfig {
   return (
     'serverConfig' in config &&
     typeof config.serverConfig === 'object' &&
     config.serverConfig !== null &&
+    'baseUrl' in config.serverConfig &&
+    typeof config.serverConfig.baseUrl === 'string' &&
+    config.serverConfig.baseUrl.length > 0 &&
     'wellknown' in config.serverConfig &&
     typeof config.serverConfig.wellknown === 'string' &&
     config.serverConfig.wellknown.length > 0