@forgerock/journey-client 0.0.0-beta-20251222204813

package/dist/src/lib/callbacks/terms-and-conditions-callback.js

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2020 - 2025 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.
+ */
+import { BaseCallback } from './base-callback.js';
+/**
+ * Represents a callback used to collect acceptance of terms and conditions.
+ */
+export class TermsAndConditionsCallback extends BaseCallback {
+    payload;
+    /**
+     * @param payload The raw payload returned by OpenAM
+     */
+    constructor(payload) {
+        super(payload);
+        this.payload = payload;
+    }
+    /**
+     * Gets the terms and conditions content.
+     */
+    getTerms() {
+        return this.getOutputByName('terms', '');
+    }
+    /**
+     * Gets the version of the terms and conditions.
+     */
+    getVersion() {
+        return this.getOutputByName('version', '');
+    }
+    /**
+     * Gets the date of the terms and conditions.
+     */
+    getCreateDate() {
+        const data = this.getOutputByName('createDate', '');
+        const date = new Date(data);
+        return Number.isNaN(date.getTime()) ? null : date;
+    }
+    /**
+     * Sets the callback's acceptance.
+     */
+    setAccepted(accepted = true) {
+        this.setInputValue(accepted);
+    }
+}

package/dist/src/lib/callbacks/text-input-callback.d.ts

@@ -0,0 +1,21 @@
+import type { Callback } from '@forgerock/sdk-types';
+import { BaseCallback } from './base-callback.js';
+/**
+ * Represents a callback used to retrieve input from the user.
+ */
+export declare class TextInputCallback extends BaseCallback {
+    payload: Callback;
+    /**
+     * @param payload The raw payload returned by OpenAM
+     */
+    constructor(payload: Callback);
+    /**
+     * Gets the callback's prompt.
+     */
+    getPrompt(): string;
+    /**
+     * Sets the callback's input value.
+     */
+    setInput(input: string): void;
+}
+//# sourceMappingURL=text-input-callback.d.ts.map

package/dist/src/lib/callbacks/text-input-callback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"text-input-callback.d.ts","sourceRoot":"","sources":["../../../../src/lib/callbacks/text-input-callback.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAErD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,YAAY;IAIrB,OAAO,EAAE,QAAQ;IAH7C;;OAEG;gBACyB,OAAO,EAAE,QAAQ;IAI7C;;OAEG;IACI,SAAS,IAAI,MAAM;IAI1B;;OAEG;IACI,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;CAGrC"}

package/dist/src/lib/callbacks/text-input-callback.js

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2022 - 2025 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.
+ */
+import { BaseCallback } from './base-callback.js';
+/**
+ * Represents a callback used to retrieve input from the user.
+ */
+export class TextInputCallback extends BaseCallback {
+    payload;
+    /**
+     * @param payload The raw payload returned by OpenAM
+     */
+    constructor(payload) {
+        super(payload);
+        this.payload = payload;
+    }
+    /**
+     * Gets the callback's prompt.
+     */
+    getPrompt() {
+        return this.getOutputByName('prompt', '');
+    }
+    /**
+     * Sets the callback's input value.
+     */
+    setInput(input) {
+        this.setInputValue(input);
+    }
+}

package/dist/src/lib/callbacks/text-output-callback.d.ts

@@ -0,0 +1,22 @@
+import type { Callback } from '@forgerock/sdk-types';
+import { BaseCallback } from './base-callback.js';
+/**
+ * Represents a callback used to display a message.
+ */
+export declare class TextOutputCallback extends BaseCallback {
+    payload: Callback;
+    /**
+     * @param payload The raw payload returned by OpenAM
+     */
+    constructor(payload: Callback);
+    /**
+     * Gets the message content.
+     */
+    getMessage(): string;
+    /**
+     * Gets the message type.
+     * Official docs state this is a number, but in practice it's a string.
+     */
+    getMessageType(): string;
+}
+//# sourceMappingURL=text-output-callback.d.ts.map

package/dist/src/lib/callbacks/text-output-callback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"text-output-callback.d.ts","sourceRoot":"","sources":["../../../../src/lib/callbacks/text-output-callback.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAErD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;IAItB,OAAO,EAAE,QAAQ;IAH7C;;OAEG;gBACyB,OAAO,EAAE,QAAQ;IAI7C;;OAEG;IACI,UAAU,IAAI,MAAM;IAI3B;;;OAGG;IACI,cAAc,IAAI,MAAM;CAGhC"}

package/dist/src/lib/callbacks/text-output-callback.js

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2020 - 2025 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.
+ */
+import { BaseCallback } from './base-callback.js';
+/**
+ * Represents a callback used to display a message.
+ */
+export class TextOutputCallback extends BaseCallback {
+    payload;
+    /**
+     * @param payload The raw payload returned by OpenAM
+     */
+    constructor(payload) {
+        super(payload);
+        this.payload = payload;
+    }
+    /**
+     * Gets the message content.
+     */
+    getMessage() {
+        return this.getOutputByName('message', '');
+    }
+    /**
+     * Gets the message type.
+     * Official docs state this is a number, but in practice it's a string.
+     */
+    getMessageType() {
+        return this.getOutputByName('messageType', '');
+    }
+}

package/dist/src/lib/callbacks/validated-create-password-callback.d.ts

@@ -0,0 +1,37 @@
+import type { Callback, PolicyRequirement } from '@forgerock/sdk-types';
+import { BaseCallback } from './base-callback.js';
+/**
+ * Represents a callback used to collect a valid platform password.
+ */
+export declare class ValidatedCreatePasswordCallback extends BaseCallback {
+    payload: Callback;
+    /**
+     * @param payload The raw payload returned by OpenAM
+     */
+    constructor(payload: Callback);
+    /**
+     * Gets the callback's failed policies.
+     */
+    getFailedPolicies(): PolicyRequirement[];
+    /**
+     * Gets the callback's applicable policies.
+     */
+    getPolicies(): Record<string, any>;
+    /**
+     * Gets the callback's prompt.
+     */
+    getPrompt(): string;
+    /**
+     * Gets whether the password is required.
+     */
+    isRequired(): boolean;
+    /**
+     * Sets the callback's password.
+     */
+    setPassword(password: string): void;
+    /**
+     * Set if validating value only.
+     */
+    setValidateOnly(value: boolean): void;
+}
+//# sourceMappingURL=validated-create-password-callback.d.ts.map

package/dist/src/lib/callbacks/validated-create-password-callback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validated-create-password-callback.d.ts","sourceRoot":"","sources":["../../../../src/lib/callbacks/validated-create-password-callback.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAExE,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,YAAY;IAInC,OAAO,EAAE,QAAQ;IAH7C;;OAEG;gBACyB,OAAO,EAAE,QAAQ;IAI7C;;OAEG;IACI,iBAAiB,IAAI,iBAAiB,EAAE;IAc/C;;OAEG;IAEI,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAKzC;;OAEG;IACI,SAAS,IAAI,MAAM;IAI1B;;OAEG;IACI,UAAU,IAAI,OAAO;IAI5B;;OAEG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAI1C;;OAEG;IACI,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;CAG7C"}

package/dist/src/lib/callbacks/validated-create-password-callback.js

@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2020 - 2025 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.
+ */
+import { BaseCallback } from './base-callback.js';
+/**
+ * Represents a callback used to collect a valid platform password.
+ */
+export class ValidatedCreatePasswordCallback extends BaseCallback {
+    payload;
+    /**
+     * @param payload The raw payload returned by OpenAM
+     */
+    constructor(payload) {
+        super(payload);
+        this.payload = payload;
+    }
+    /**
+     * Gets the callback's failed policies.
+     */
+    getFailedPolicies() {
+        const failedPolicies = this.getOutputByName('failedPolicies', []);
+        try {
+            return failedPolicies.map((v) => JSON.parse(v));
+        }
+        catch {
+            throw new Error('Unable to parse "failed policies" from the ForgeRock server. The JSON within `ValidatedCreatePasswordCallback` was either malformed or missing.');
+        }
+    }
+    /**
+     * Gets the callback's applicable policies.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    getPolicies() {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return this.getOutputByName('policies', {});
+    }
+    /**
+     * Gets the callback's prompt.
+     */
+    getPrompt() {
+        return this.getOutputByName('prompt', '');
+    }
+    /**
+     * Gets whether the password is required.
+     */
+    isRequired() {
+        return this.getOutputByName('required', false);
+    }
+    /**
+     * Sets the callback's password.
+     */
+    setPassword(password) {
+        this.setInputValue(password);
+    }
+    /**
+     * Set if validating value only.
+     */
+    setValidateOnly(value) {
+        this.setInputValue(value, /validateOnly/);
+    }
+}

package/dist/src/lib/callbacks/validated-create-username-callback.d.ts

@@ -0,0 +1,37 @@
+import type { Callback, PolicyRequirement } from '@forgerock/sdk-types';
+import { BaseCallback } from './base-callback.js';
+/**
+ * Represents a callback used to collect a valid platform username.
+ */
+export declare class ValidatedCreateUsernameCallback extends BaseCallback {
+    payload: Callback;
+    /**
+     * @param payload The raw payload returned by OpenAM
+     */
+    constructor(payload: Callback);
+    /**
+     * Gets the callback's prompt.
+     */
+    getPrompt(): string;
+    /**
+     * Gets the callback's failed policies.
+     */
+    getFailedPolicies(): PolicyRequirement[];
+    /**
+     * Gets the callback's applicable policies.
+     */
+    getPolicies(): Record<string, any>;
+    /**
+     * Gets whether the username is required.
+     */
+    isRequired(): boolean;
+    /**
+     * Sets the callback's username.
+     */
+    setName(name: string): void;
+    /**
+     * Set if validating value only.
+     */
+    setValidateOnly(value: boolean): void;
+}
+//# sourceMappingURL=validated-create-username-callback.d.ts.map

package/dist/src/lib/callbacks/validated-create-username-callback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validated-create-username-callback.d.ts","sourceRoot":"","sources":["../../../../src/lib/callbacks/validated-create-username-callback.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAExE,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,YAAY;IAInC,OAAO,EAAE,QAAQ;IAH7C;;OAEG;gBACyB,OAAO,EAAE,QAAQ;IAI7C;;OAEG;IACI,SAAS,IAAI,MAAM;IAI1B;;OAEG;IACI,iBAAiB,IAAI,iBAAiB,EAAE;IAc/C;;OAEG;IAEI,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAKzC;;OAEG;IACI,UAAU,IAAI,OAAO;IAI5B;;OAEG;IACI,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAIlC;;OAEG;IACI,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;CAG7C"}

package/dist/src/lib/callbacks/validated-create-username-callback.js

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2025 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.
+ */
+import { BaseCallback } from './base-callback.js';
+/**
+ * Represents a callback used to collect a valid platform username.
+ */
+export class ValidatedCreateUsernameCallback extends BaseCallback {
+    payload;
+    /**
+     * @param payload The raw payload returned by OpenAM
+     */
+    constructor(payload) {
+        super(payload);
+        this.payload = payload;
+    }
+    /**
+     * Gets the callback's prompt.
+     */
+    getPrompt() {
+        return this.getOutputByName('prompt', '');
+    }
+    /**
+     * Gets the callback's failed policies.
+     */
+    getFailedPolicies() {
+        const failedPolicies = this.getOutputByName('failedPolicies', []);
+        try {
+            return failedPolicies.map((v) => JSON.parse(v));
+        }
+        catch {
+            throw new Error('Unable to parse "failed policies" from the ForgeRock server. The JSON within `ValidatedCreateUsernameCallback` was either malformed or missing.');
+        }
+    }
+    /**
+     * Gets the callback's applicable policies.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    getPolicies() {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return this.getOutputByName('policies', {});
+    }
+    /**
+     * Gets whether the username is required.
+     */
+    isRequired() {
+        return this.getOutputByName('required', false);
+    }
+    /**
+     * Sets the callback's username.
+     */
+    setName(name) {
+        this.setInputValue(name);
+    }
+    /**
+     * Set if validating value only.
+     */
+    setValidateOnly(value) {
+        this.setInputValue(value, /validateOnly/);
+    }
+}

package/dist/src/lib/client.store.d.ts

@@ -0,0 +1,37 @@
+import { LogLevel, CustomLogger } from '@forgerock/sdk-logger';
+import type { RequestMiddleware } from '@forgerock/sdk-request-middleware';
+import { createJourneyObject } from './journey.utils.js';
+import type { JourneyStep } from './step.utils.js';
+import type { JourneyClientConfig } from './config.types.js';
+import { NextOptions, StartParam, ResumeOptions } from './interfaces.js';
+export declare function journey({ config, requestMiddleware, logger, }: {
+    config: JourneyClientConfig;
+    requestMiddleware?: RequestMiddleware[];
+    logger?: {
+        level: LogLevel;
+        custom?: CustomLogger;
+    };
+}): Promise<{
+    start: (options?: StartParam) => Promise<JourneyStep | import("./login-success.utils.js").JourneyLoginSuccess | import("./login-failure.utils.js").JourneyLoginFailure | undefined>;
+    /**
+     * Submits the current Step payload to the authentication API and retrieves the next JourneyStep in the journey.
+     * The `step` to be submitted is provided within the `options` object.
+     *
+     * @param options An object containing the current Step payload and optional JourneyClientConfig.
+     * @returns A Promise that resolves to the next JourneyStep in the journey, or undefined if the journey ends.
+     */
+    next: (step: JourneyStep, options?: NextOptions) => Promise<JourneyStep | import("./login-success.utils.js").JourneyLoginSuccess | import("./login-failure.utils.js").JourneyLoginFailure | undefined>;
+    redirect: (step: JourneyStep) => Promise<void>;
+    resume: (url: string, options?: ResumeOptions) => Promise<ReturnType<typeof createJourneyObject> | undefined>;
+    /**
+     * Ends the current authentication session by calling the `/sessions` endpoint.
+     * This will invalidate the current session and clean up any server-side state.
+     *
+     * @param options Optional StepOptions containing query parameters.
+     * @returns A Promise that resolves when the session is successfully ended.
+     */
+    terminate: (options?: {
+        query?: Record<string, string>;
+    }) => Promise<void | undefined>;
+}>;
+//# sourceMappingURL=client.store.d.ts.map

package/dist/src/lib/client.store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.store.d.ts","sourceRoot":"","sources":["../../../src/lib/client.store.ts"],"names":[],"mappings":"AAOA,OAAO,EAAsB,QAAQ,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAGnF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AAO3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAEzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAE7D,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAsBzE,wBAAsB,OAAO,CAAC,EAC5B,MAAM,EACN,iBAAiB,EACjB,MAAM,GACP,EAAE;IACD,MAAM,EAAE,mBAAmB,CAAC;IAC5B,iBAAiB,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACxC,MAAM,CAAC,EAAE;QACP,KAAK,EAAE,QAAQ,CAAC;QAChB,MAAM,CAAC,EAAE,YAAY,CAAC;KACvB,CAAC;CACH;sBAe2B,UAAU;IAKlC;;;;;;OAMG;iBACgB,WAAW,YAAY,WAAW;qBAM9B,WAAW;kBAoB3B,MAAM,YACD,aAAa,KACtB,OAAO,CAAC,UAAU,CAAC,OAAO,mBAAmB,CAAC,GAAG,SAAS,CAAC;IAsE9D;;;;;;OAMG;0BACyB;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE;GAMjE"}

package/dist/src/lib/client.store.js

@@ -0,0 +1,147 @@
+/*
+ * Copyright (c) 2025 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.
+ */
+import { logger as loggerFn } from '@forgerock/sdk-logger';
+import { callbackType } from '@forgerock/sdk-types';
+import { createJourneyStore } from './client.store.utils.js';
+import { journeyApi } from './journey.api.js';
+import { setConfig } from './journey.slice.js';
+import { createStorage } from '@forgerock/storage';
+import { createJourneyObject } from './journey.utils.js';
+/**
+ * Normalizes the serverConfig to ensure baseUrl has a trailing slash.
+ * This is required for the resolve() function to work correctly with context paths like /am.
+ */
+function normalizeConfig(config) {
+    if (config.serverConfig?.baseUrl) {
+        const url = config.serverConfig.baseUrl;
+        if (url.charAt(url.length - 1) !== '/') {
+            return {
+                ...config,
+                serverConfig: {
+                    ...config.serverConfig,
+                    baseUrl: url + '/',
+                },
+            };
+        }
+    }
+    return config;
+}
+export async function journey({ config, requestMiddleware, logger, }) {
+    const log = loggerFn({ level: logger?.level || 'error', custom: logger?.custom });
+    // Normalize config to ensure baseUrl has trailing slash
+    const normalizedConfig = normalizeConfig(config);
+    const store = createJourneyStore({ requestMiddleware, logger: log, config: normalizedConfig });
+    store.dispatch(setConfig(normalizedConfig));
+    const stepStorage = createStorage({
+        type: 'sessionStorage',
+        name: 'journey-step',
+    });
+    const self = {
+        start: async (options) => {
+            const { data } = await store.dispatch(journeyApi.endpoints.start.initiate(options));
+            return data ? createJourneyObject(data) : undefined;
+        },
+        /**
+         * Submits the current Step payload to the authentication API and retrieves the next JourneyStep in the journey.
+         * The `step` to be submitted is provided within the `options` object.
+         *
+         * @param options An object containing the current Step payload and optional JourneyClientConfig.
+         * @returns A Promise that resolves to the next JourneyStep in the journey, or undefined if the journey ends.
+         */
+        next: async (step, options) => {
+            const { data } = await store.dispatch(journeyApi.endpoints.next.initiate({ step, options }));
+            return data ? createJourneyObject(data) : undefined;
+        },
+        // TODO: Remove the actual redirect from this method and just return the URL to the caller
+        redirect: async (step) => {
+            const cb = step.getCallbackOfType(callbackType.RedirectCallback);
+            if (!cb) {
+                // TODO: Remove throwing errors from SDK and use Result types instead
+                throw new Error('RedirectCallback not found on step');
+            }
+            const redirectUrl = cb.getRedirectUrl();
+            if (!redirectUrl || typeof redirectUrl !== 'string') {
+                throw new Error('Redirect URL not found on RedirectCallback');
+            }
+            const err = await stepStorage.set({ step: step.payload });
+            if (err && err.error) {
+                log.warn('Failed to persist step before redirect', err);
+            }
+            window.location.assign(redirectUrl);
+        },
+        resume: async (url, options) => {
+            const parsedUrl = new URL(url);
+            const code = parsedUrl.searchParams.get('code');
+            const state = parsedUrl.searchParams.get('state');
+            const form_post_entry = parsedUrl.searchParams.get('form_post_entry');
+            const responsekey = parsedUrl.searchParams.get('responsekey');
+            let previousStep; // Declare previousStep here
+            function requiresPreviousStep() {
+                return (code && state) || form_post_entry || responsekey;
+            }
+            // Type guard for GenericError (assuming GenericError has 'error' and 'message' properties)
+            function isGenericError(obj) {
+                return typeof obj === 'object' && obj !== null && 'error' in obj && 'message' in obj;
+            }
+            // Type guard for { step: JourneyStep }
+            function isStoredStep(obj) {
+                return (typeof obj === 'object' &&
+                    obj !== null &&
+                    'step' in obj &&
+                    typeof obj.step === 'object');
+            }
+            if (requiresPreviousStep()) {
+                const stored = await stepStorage.get();
+                if (stored) {
+                    if (isGenericError(stored)) {
+                        // If the stored item is a GenericError, it means something went wrong during storage/retrieval
+                        // or the previous step was an error.
+                        // TODO: Remove throwing errors from SDK and use Result types instead
+                        throw new Error(`Error retrieving previous step: ${stored.message || stored.error}`);
+                    }
+                    else if (isStoredStep(stored)) {
+                        previousStep = createJourneyObject(stored.step);
+                    }
+                }
+                await stepStorage.remove();
+                if (!previousStep) {
+                    throw new Error('Error: previous step information not found in storage for resume operation.');
+                }
+            }
+            const resumeOptions = {
+                ...options,
+                query: {
+                    ...(options && options.query), // Spread options.query first
+                    ...(code && { code }),
+                    ...(state && { state }),
+                    ...(form_post_entry && { form_post_entry }),
+                    ...(responsekey && { responsekey }),
+                },
+            };
+            if (previousStep) {
+                return await self.next(previousStep, resumeOptions);
+            }
+            else {
+                // TODO: We should better handle this type misalignment
+                const startOptions = resumeOptions;
+                return await self.start(startOptions);
+            }
+        },
+        /**
+         * Ends the current authentication session by calling the `/sessions` endpoint.
+         * This will invalidate the current session and clean up any server-side state.
+         *
+         * @param options Optional StepOptions containing query parameters.
+         * @returns A Promise that resolves when the session is successfully ended.
+         */
+        terminate: async (options) => {
+            const { data } = await store.dispatch(journeyApi.endpoints.terminate.initiate(options));
+            return data;
+        },
+    };
+    return self;
+}

package/dist/src/lib/client.store.utils.d.ts

@@ -0,0 +1,81 @@
+import { logger as loggerFn } from '@forgerock/sdk-logger';
+import { RequestMiddleware } from '@forgerock/sdk-request-middleware';
+import { JourneyClientConfig } from './config.types.js';
+declare const rootReducer: import("@reduxjs/toolkit").Reducer<{
+    [x: string]: never;
+    journeyReducer: import("@reduxjs/toolkit/query").CombinedState<{
+        start: import("@reduxjs/toolkit/query").MutationDefinition<import("./interfaces.js").StartParam | undefined, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, import("@forgerock/sdk-types").Step, "journeyReducer", unknown>;
+        next: import("@reduxjs/toolkit/query").MutationDefinition<{
+            step: import("./step.types.js").JourneyStep;
+            options?: import("./interfaces.js").NextOptions;
+        }, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, import("@forgerock/sdk-types").Step, "journeyReducer", unknown>;
+        terminate: import("@reduxjs/toolkit/query").MutationDefinition<{
+            query?: Record<string, string>;
+        } | undefined, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, void, "journeyReducer", unknown>;
+    }, never, "journeyReducer">;
+}, import("@reduxjs/toolkit").UnknownAction, Partial<{
+    [x: string]: (import("@reduxjs/toolkit/query").CombinedState<{
+        start: import("@reduxjs/toolkit/query").MutationDefinition<import("./interfaces.js").StartParam | undefined, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, import("@forgerock/sdk-types").Step, "journeyReducer", unknown>;
+        next: import("@reduxjs/toolkit/query").MutationDefinition<{
+            step: import("./step.types.js").JourneyStep;
+            options?: import("./interfaces.js").NextOptions;
+        }, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, import("@forgerock/sdk-types").Step, "journeyReducer", unknown>;
+        terminate: import("@reduxjs/toolkit/query").MutationDefinition<{
+            query?: Record<string, string>;
+        } | undefined, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, void, "journeyReducer", unknown>;
+    }, never, "journeyReducer"> & import("./journey.slice.js").JourneyState) | undefined;
+    journeyReducer: import("@reduxjs/toolkit/query").CombinedState<{
+        start: import("@reduxjs/toolkit/query").MutationDefinition<import("./interfaces.js").StartParam | undefined, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, import("@forgerock/sdk-types").Step, "journeyReducer", unknown>;
+        next: import("@reduxjs/toolkit/query").MutationDefinition<{
+            step: import("./step.types.js").JourneyStep;
+            options?: import("./interfaces.js").NextOptions;
+        }, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, import("@forgerock/sdk-types").Step, "journeyReducer", unknown>;
+        terminate: import("@reduxjs/toolkit/query").MutationDefinition<{
+            query?: Record<string, string>;
+        } | undefined, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, void, "journeyReducer", unknown>;
+    }, never, "journeyReducer"> | undefined;
+}>>;
+export declare const createJourneyStore: ({ requestMiddleware, logger, config, }: {
+    requestMiddleware?: RequestMiddleware[];
+    logger?: ReturnType<typeof loggerFn>;
+    config: JourneyClientConfig;
+}) => import("@reduxjs/toolkit").EnhancedStore<{
+    [x: string]: never;
+    journeyReducer: import("@reduxjs/toolkit/query").CombinedState<{
+        start: import("@reduxjs/toolkit/query").MutationDefinition<import("./interfaces.js").StartParam | undefined, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, import("@forgerock/sdk-types").Step, "journeyReducer", unknown>;
+        next: import("@reduxjs/toolkit/query").MutationDefinition<{
+            step: import("./step.types.js").JourneyStep;
+            options?: import("./interfaces.js").NextOptions;
+        }, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, import("@forgerock/sdk-types").Step, "journeyReducer", unknown>;
+        terminate: import("@reduxjs/toolkit/query").MutationDefinition<{
+            query?: Record<string, string>;
+        } | undefined, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, void, "journeyReducer", unknown>;
+    }, never, "journeyReducer">;
+}, import("@reduxjs/toolkit").UnknownAction, import("@reduxjs/toolkit").Tuple<[import("@reduxjs/toolkit").StoreEnhancer<{
+    dispatch: import("@reduxjs/toolkit").ThunkDispatch<{
+        [x: string]: never;
+        journeyReducer: import("@reduxjs/toolkit/query").CombinedState<{
+            start: import("@reduxjs/toolkit/query").MutationDefinition<import("./interfaces.js").StartParam | undefined, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, import("@forgerock/sdk-types").Step, "journeyReducer", unknown>;
+            next: import("@reduxjs/toolkit/query").MutationDefinition<{
+                step: import("./step.types.js").JourneyStep;
+                options?: import("./interfaces.js").NextOptions;
+            }, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, import("@forgerock/sdk-types").Step, "journeyReducer", unknown>;
+            terminate: import("@reduxjs/toolkit/query").MutationDefinition<{
+                query?: Record<string, string>;
+            } | undefined, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, void, "journeyReducer", unknown>;
+        }, never, "journeyReducer">;
+    }, {
+        requestMiddleware: RequestMiddleware[] | undefined;
+        logger: {
+            changeLevel: (level: import("@forgerock/sdk-logger").LogLevel) => void;
+            error: (...args: import("@forgerock/sdk-logger").LogMessage[]) => void;
+            warn: (...args: import("@forgerock/sdk-logger").LogMessage[]) => void;
+            info: (...args: import("@forgerock/sdk-logger").LogMessage[]) => void;
+            debug: (...args: import("@forgerock/sdk-logger").LogMessage[]) => void;
+        } | undefined;
+        config: JourneyClientConfig;
+    }, import("@reduxjs/toolkit").UnknownAction>;
+}>, import("@reduxjs/toolkit").StoreEnhancer]>>;
+export type RootState = ReturnType<typeof rootReducer>;
+export {};
+//# sourceMappingURL=client.store.utils.d.ts.map

package/dist/src/lib/client.store.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.store.utils.d.ts","sourceRoot":"","sources":["../../../src/lib/client.store.utils.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,MAAM,IAAI,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AAKtE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAExD,QAAA,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAGf,CAAC;AAEH,eAAO,MAAM,kBAAkB,GAAI,wCAIhC;IACD,iBAAiB,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACxC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAC;IACrC,MAAM,EAAE,mBAAmB,CAAC;CAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBArBmB,GAAG;mBACpB,GAAG;mBAAwC,GAAG;oBAC9B,GAAG;;;;+CAkCrB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC"}