fix(journey-client): create JourneyLoginFailure step and handle LoginFailure case

Author: vatsalparikh

…et/journey-loginfailure-on-error-code.md .changeset/whole-mangos-find.md.changeset/journey-loginfailure-on-error-code.md renamed to .changeset/whole-mangos-find.md .changeset/journey-loginfailure-on-error-code.md renamed to .changeset/whole-mangos-find.md

@@ -2,4 +2,4 @@
 '@forgerock/journey-client': patch
 ---
 
-Return `JourneyLoginFailure` by hitting the previously-unreached `LoginFailure` branch when `start()`/`next()` receives a failure payload with a `code`.
+Return `JourneyLoginFailure` by hitting the previously-unreached `LoginFailure` branch when `start()`/`next()` receives a failure payload with a login failure `code`

packages/journey-client/src/lib/client.store.test.ts

@@ -1,6 +1,6 @@
 // @vitest-environment node
 /*
- * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
+ * Copyright (c) 2025-2026 Ping Identity Corporation. All rights reserved.
  *
  * This software may be modified and distributed under the terms
  * of the MIT license. See the LICENSE file for details.

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
+ * Copyright (c) 2025-2026 Ping Identity Corporation. All rights reserved.
  *
  * This software may be modified and distributed under the terms
  * of the MIT license. See the LICENSE file for details.
@@ -16,7 +16,6 @@ import {
 import type { GenericError } from '@forgerock/sdk-types';
 import type { ActionTypes, RequestMiddleware } from '@forgerock/sdk-request-middleware';
 import type { Step } from '@forgerock/sdk-types';
-import type { FetchBaseQueryError } from '@reduxjs/toolkit/query';
 
 import { createJourneyStore } from './client.store.utils.js';
 import { configSlice } from './config.slice.js';
@@ -156,17 +155,11 @@ export async function journey<ActionType extends ActionTypes = ActionTypes>({
 
   const self: JourneyClient = {
     start: async (options?: StartParam) => {
-      const { data, error } = await store.dispatch(journeyApi.endpoints.start.initiate(options));
+      const { data } = await store.dispatch(journeyApi.endpoints.start.initiate(options));
       if (data) {
         return createJourneyObject(data);
       }
 
-      const errorData = (error as FetchBaseQueryError | undefined)?.data;
-      const errorStep = errorData as Step | undefined;
-      if (errorStep?.code !== undefined) {
-        return createJourneyObject(errorStep);
-      }
-
       const genericError: GenericError = {
         error: 'no_response_data',
         message: 'No data received from server when starting journey',
@@ -179,19 +172,11 @@ export async function journey<ActionType extends ActionTypes = ActionTypes>({
      * Submits the current Step payload to the authentication API and retrieves the next JourneyStep in the journey.
      */
     next: async (step: JourneyStep, options?: NextOptions) => {
-      const { data, error } = await store.dispatch(
-        journeyApi.endpoints.next.initiate({ step, options }),
-      );
+      const { data } = await store.dispatch(journeyApi.endpoints.next.initiate({ step, options }));
       if (data) {
         return createJourneyObject(data);
       }
 
-      const errorData = (error as FetchBaseQueryError | undefined)?.data;
-      const errorStep = errorData as Step | undefined;
-      if (errorStep?.code !== undefined) {
-        return createJourneyObject(errorStep);
-      }
-
       const genericError: GenericError = {
         error: 'no_response_data',
         message: 'No data received from server when submitting step',

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

@@ -89,6 +89,9 @@ interface Extras {
   logger: ReturnType<typeof loggerFn>;
 }
 
+// Only treat these numeric codes as login failures coming back in the Step payload.
+const LOGIN_FAILURE_CODES = [400, 401, 403, 412, 423, 429];
+
 export const journeyApi = createApi({
   reducerPath: 'journeyReducer',
   baseQuery: fetchBaseQuery({
@@ -133,6 +136,24 @@ export const journeyApi = createApi({
             return result as QueryReturnValue<unknown, FetchBaseQueryError, FetchBaseQueryMeta>;
           });
 
+        /**
+         * If the endpoint returned an HTTP error whose body is an AM Step with a
+         * login-failure code, treat it as successful data so callers receive the
+         * Step via the `data` path (keeps downstream logic simpler).
+         */
+        if ('error' in response) {
+          const errorData = (response.error as FetchBaseQueryError | undefined)?.data as
+            | Step
+            | undefined;
+          if (errorData && errorData.code && LOGIN_FAILURE_CODES.includes(errorData.code)) {
+            return { data: errorData } as QueryReturnValue<
+              Step,
+              FetchBaseQueryError,
+              FetchBaseQueryMeta
+            >;
+          }
+        }
+
         return response as QueryReturnValue<Step, FetchBaseQueryError, FetchBaseQueryMeta>;
       },
     }),
@@ -162,6 +183,24 @@ export const journeyApi = createApi({
             return result as QueryReturnValue<unknown, FetchBaseQueryError, FetchBaseQueryMeta>;
           });
 
+        /**
+         * If the endpoint returned an HTTP error whose body is an AM Step with a
+         * login-failure code, treat it as successful data so callers receive the
+         * Step via the `data` path (keeps downstream logic simpler).
+         */
+        if ('error' in response) {
+          const errorData = (response.error as FetchBaseQueryError | undefined)?.data as
+            | Step
+            | undefined;
+          if (errorData && errorData.code && LOGIN_FAILURE_CODES.includes(errorData.code)) {
+            return { data: errorData } as QueryReturnValue<
+              Step,
+              FetchBaseQueryError,
+              FetchBaseQueryMeta
+            >;
+          }
+        }
+
         return response as QueryReturnValue<Step, FetchBaseQueryError, FetchBaseQueryMeta>;
       },
     }),