@forgerock/journey-client 0.0.0-beta-20251222204813

package/src/lib/recovery-codes/recovery-codes.test.ts

@@ -0,0 +1,43 @@
+/*
+ * @forgerock/ping-javascript-sdk
+ *
+ * recovery-codes.test.ts
+ *
+ * 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 { RecoveryCodes } from './recovery-codes.js';
+import { createJourneyStep } from '../step.utils.js';
+import {
+  displayRecoveryCodesResponse,
+  expectedDeviceName,
+  expectedRecoveryCodes,
+  otherResponse,
+} from './script-text.mock.data.js';
+
+describe('Class for managing the Display Recovery Codes node', () => {
+  it('should return true if Display Recovery Codes step', () => {
+    const step = createJourneyStep(displayRecoveryCodesResponse);
+    const isDisplayStep = RecoveryCodes.isDisplayStep(step);
+    expect(isDisplayStep).toBe(true);
+  });
+
+  it('should return false if not Display Recovery Codes step', () => {
+    const step = createJourneyStep(otherResponse);
+    const isDisplayStep = RecoveryCodes.isDisplayStep(step);
+    expect(isDisplayStep).toBe(false);
+  });
+
+  it('should return the Recovery Codes as array of strings', () => {
+    const step = createJourneyStep(displayRecoveryCodesResponse);
+    const recoveryCodes = RecoveryCodes.getCodes(step);
+    expect(recoveryCodes).toStrictEqual(expectedRecoveryCodes);
+  });
+  it('should return a display name from the getDisplayName method', () => {
+    const step = createJourneyStep(displayRecoveryCodesResponse);
+    const displayName = RecoveryCodes.getDeviceName(step);
+    expect(displayName).toStrictEqual(expectedDeviceName);
+  });
+});

package/src/lib/recovery-codes/recovery-codes.ts

@@ -0,0 +1,72 @@
+/*
+ * @forgerock/ping-javascript-sdk
+ *
+ * index.ts
+ *
+ * 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 { callbackType } from '@forgerock/sdk-types';
+
+import { parseDeviceNameText, parseDisplayRecoveryCodesText } from './script-parser.js';
+
+import type { TextOutputCallback } from '../callbacks/text-output-callback.js';
+import type { JourneyStep } from '../step.utils.js';
+
+/**
+ * Utility for handling recovery code nodes.
+ *
+ * Example:
+ *
+ * ```js
+ * // Determine if step is Display Recovery Codes step
+ * const isDisplayRecoveryCodesStep = RecoveryCodes.isDisplayStep(step);
+ * if (isDisplayRecoveryCodesStep) {
+ *   const recoveryCodes = RecoveryCodes.getCodes(step);
+ *   // Do the UI needful
+ * }
+ * ```
+ */
+export abstract class RecoveryCodes {
+  public static getDeviceName(step: JourneyStep): string {
+    const text = this.getDisplayCallback(step)?.getOutputByName('message', '') ?? '';
+    return parseDeviceNameText(text);
+  }
+  /**
+   * Retrieves the recovery codes by parsing the JavaScript message text in callback.
+   *
+   * @param step The step to evaluate
+   * @return Recovery Code values in array
+   */
+  public static getCodes(step: JourneyStep): string[] {
+    const text = this.getDisplayCallback(step)?.getOutputByName('message', '');
+    return parseDisplayRecoveryCodesText(text || '');
+  }
+
+  /**
+   * Determines if the given step is a Display Recovery Codes step.
+   *
+   * @param step The step to evaluate
+   * @return Is this step a Display Recovery Codes step
+   */
+  public static isDisplayStep(step: JourneyStep): boolean {
+    return !!this.getDisplayCallback(step);
+  }
+
+  /**
+   * Gets the recovery codes step.
+   *
+   * @param step The step to evaluate
+   * @return gets the Display Recovery Codes' callback
+   */
+  private static getDisplayCallback(step: JourneyStep): TextOutputCallback | undefined {
+    return step
+      .getCallbacksOfType<TextOutputCallback>(callbackType.TextOutputCallback)
+      .find((x) => {
+        const cb = x.getOutputByName<string | undefined>('message', undefined);
+        return cb && (cb.includes('Recovery Codes') || cb.includes('recovery codes'));
+      });
+  }
+}

package/src/lib/recovery-codes/script-parser.test.ts

@@ -0,0 +1,34 @@
+/*
+ * @forgerock/ping-javascript-sdk
+ *
+ * script-parser.test.ts
+ *
+ * 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 { parseDeviceNameText, parseDisplayRecoveryCodesText } from './script-parser.js';
+import {
+  displayRecoveryCodes,
+  expectedRecoveryCodes,
+  securityKeyCustomNameResponse,
+  securityKeyResponse,
+} from './script-text.mock.data.js';
+
+describe('Parsing of the Display Recovery Codes script text', () => {
+  it('should parse the Display Recovery Codes Text', () => {
+    const result = parseDisplayRecoveryCodesText(displayRecoveryCodes);
+    expect(result).toStrictEqual(expectedRecoveryCodes);
+  });
+  it('should parse the display name from recovery codes script', () => {
+    const text = securityKeyResponse;
+    const result = parseDeviceNameText(text);
+    expect(result).toStrictEqual('New Security Key');
+  });
+  it('should parse a custom name out of the recovery text', () => {
+    const text = securityKeyCustomNameResponse;
+    const result = parseDeviceNameText(text);
+    expect(result).toStrictEqual('My Custom Device Name');
+  });
+});

package/src/lib/recovery-codes/script-parser.ts

@@ -0,0 +1,50 @@
+/*
+ * @forgerock/ping-javascript-sdk
+ *
+ * script-parser.ts
+ *
+ * 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.
+ */
+
+export function parseDisplayRecoveryCodesText(text: string): string[] {
+  /**
+   * e.g. ` ...
+   *    "<div class=\"text-center\">\n" +
+   *    "iZmEtxvQ00\n" +
+   *    "</div>\n" +
+   * ... `
+   */
+
+  const recoveryCodesMatches = text.match(/\s[\w\W]"([\w]*)\\/g);
+  const recoveryCodes =
+    Array.isArray(recoveryCodesMatches) &&
+    recoveryCodesMatches.map((substr: string) => {
+      // e.g. `"iZmEtxvQ00\`
+      const arr = substr.match(/"([\w]*)\\/);
+      return Array.isArray(arr) ? arr[1] : '';
+    });
+  return recoveryCodes || [];
+}
+
+/**
+ *
+ * @param text
+ * @returns string
+ */
+export function parseDeviceNameText(text: string): string {
+  /**
+   * We default the device name to 'New Security Key'
+   * If the user has a device name, it will be wrapped in <em> tags
+   * e.g. ` ... <em>My Security Key</em> ... `
+   * We want to remove the <em> tags and just return the device name
+   * e.g. ` ... My Security Key ... `
+   */
+  const displayName =
+    text
+      ?.match(/<em\s*.*>\s*.*<\/em>/g)?.[0]
+      ?.replace('<em>', '')
+      ?.replace('</em>', '') ?? 'New Security Key';
+  return displayName;
+}

package/src/lib/recovery-codes/script-text.mock.data.ts

@@ -0,0 +1,120 @@
+/* eslint-disable no-useless-escape */
+/*
+ * @forgerock/ping-javascript-sdk
+ *
+ * script-text.mock.data.ts
+ *
+ * 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 { callbackType } from '@forgerock/sdk-types';
+
+const displayRecoveryCodes = `/*
+* Copyright 2018 ForgeRock AS. All Rights Reserved
+*
+* Use of this code requires a commercial software license with ForgeRock AS.
+* or with one of its affiliates. All use shall be exclusively subject
+* to such license between the licensee and ForgeRock AS.
+*/\n\nvar newLocation = document.getElementById(\"wrapper\");\nvar oldHtml = newLocation.getElementsByTagName(\"fieldset\")[0].innerHTML;\nnewLocation.getElementsByTagName(\"fieldset\")[0].innerHTML = \"<div class=\\\"panel panel-default\\\">\\n\" +
+   \"    <div class=\\\"panel-body text-center\\\">\\n\" +
+   \"        <h3>Your Recovery Codes</h3>\\n\" +
+   \"        <h4>You must make a copy of these WebAuthn authenticator recovery codes. They cannot be displayed again.</h4>\\n\" +
+   \"    </div>\\n\" +
+   \"<div class=\\\"text-center\\\">\\n\" +
+   \"iZmEtxvQ00\\n\" +
+   \"</div>\\n\" +
+   \"<div class=\\\"text-center\\\">\\n\" +
+   \"Eqw3GFVamY\\n\" +
+   \"</div>\\n\" +
+   \"<div class=\\\"text-center\\\">\\n\" +
+   \"nNPqIEtIpS\\n\" +
+   \"</div>\\n\" +
+   \"<div class=\\\"text-center\\\">\\n\" +
+   \"vGhNQpDjP8\\n\" +
+   \"</div>\\n\" +
+   \"<div class=\\\"text-center\\\">\\n\" +
+   \"ItA4W3iBaA\\n\" +
+   \"</div>\\n\" +
+   \"<div class=\\\"text-center\\\">\\n\" +
+   \"JmLQP6XyIo\\n\" +
+   \"</div>\\n\" +
+   \"<div class=\\\"text-center\\\">\\n\" +
+   \"G2e6foNKke\\n\" +
+   \"</div>\\n\" +
+   \"<div class=\\\"text-center\\\">\\n\" +
+   \"h2SqAqvT21\\n\" +
+   \"</div>\\n\" +
+   \"<div class=\\\"text-center\\\">\\n\" +
+   \"q6VX1ojNbI\\n\" +
+   \"</div>\\n\" +
+   \"<div class=\\\"text-center\\\">\\n\" +
+   \"IZKIQXAfY2\\n\" +
+   \"</div>\\n\" +
+   \"<div class=\\\"panel-body text-center\\\">\\n\" +
+   \"        <p>Use one of these codes to authenticate if you lose your device, which has been named: <em>New Security Key</em></p>\\n\" +
+   \"</div>\\n\" +
+   \"</div>\" + oldHtml;\ndocument.body.appendChild(newLocation);\n\n\n
+`;
+
+const displayRecoveryCodesResponse = {
+  authId: 'foo',
+  callbacks: [
+    {
+      type: callbackType.TextOutputCallback,
+      output: [
+        {
+          name: 'message',
+          value:
+            '/*\n * Copyright 2018 ForgeRock AS. All Rights Reserved\n *\n * Use of this code requires a commercial software license with ForgeRock AS.\n * or with one of its affiliates. All use shall be exclusively subject\n * to such license between the licensee and ForgeRock AS.\n */\n\nvar newLocation = document.getElementById("wrapper");\nvar oldHtml = newLocation.getElementsByTagName("fieldset")[0].innerHTML;\nnewLocation.getElementsByTagName("fieldset")[0].innerHTML = "<div class=\\"panel panel-default\\">\\n" +\n    "    <div class=\\"panel-body text-center\\">\\n" +\n    "        <h3>Your Recovery Codes</h3>\\n" +\n    "        <h4>You must make a copy of these WebAuthn authenticator recovery codes. They cannot be displayed again.</h4>\\n" +\n    "    </div>\\n" +\n    "<div class=\\"text-center\\">\\n" +\n    "iZmEtxvQ00\\n" +\n    "</div>\\n" +\n    "<div class=\\"text-center\\">\\n" +\n    "Eqw3GFVamY\\n" +\n    "</div>\\n" +\n    "<div class=\\"text-center\\">\\n" +\n    "nNPqIEtIpS\\n" +\n    "</div>\\n" +\n    "<div class=\\"text-center\\">\\n" +\n    "vGhNQpDjP8\\n" +\n    "</div>\\n" +\n    "<div class=\\"text-center\\">\\n" +\n    "ItA4W3iBaA\\n" +\n    "</div>\\n" +\n    "<div class=\\"text-center\\">\\n" +\n    "JmLQP6XyIo\\n" +\n    "</div>\\n" +\n    "<div class=\\"text-center\\">\\n" +\n    "G2e6foNKke\\n" +\n    "</div>\\n" +\n    "<div class=\\"text-center\\">\\n" +\n    "h2SqAqvT21\\n" +\n    "</div>\\n" +\n    "<div class=\\"text-center\\">\\n" +\n    "q6VX1ojNbI\\n" +\n    "</div>\\n" +\n    "<div class=\\"text-center\\">\\n" +\n    "IZKIQXAfY2\\n" +\n    "</div>\\n" +\n    "<div class=\\"panel-body text-center\\">\\n" +\n    "        <p>Use one of these codes to authenticate if you lose your device, which has been named: <em>New Security Key</em></p>\\n" +\n    "</div>\\n" +\n    "</div>" + oldHtml;\ndocument.body.appendChild(newLocation);\n\n\n',
+        },
+        { name: 'messageType', value: '4' },
+      ],
+    },
+  ],
+};
+const expectedDeviceName = 'New Security Key';
+
+const expectedRecoveryCodes = [
+  'iZmEtxvQ00',
+  'Eqw3GFVamY',
+  'nNPqIEtIpS',
+  'vGhNQpDjP8',
+  'ItA4W3iBaA',
+  'JmLQP6XyIo',
+  'G2e6foNKke',
+  'h2SqAqvT21',
+  'q6VX1ojNbI',
+  'IZKIQXAfY2',
+];
+
+const otherResponse = {
+  authId: 'foo',
+  callbacks: [
+    {
+      type: callbackType.TextOutputCallback,
+      output: [
+        {
+          name: 'message',
+          value:
+            '/*\n * Copyright 2018 ForgeRock AS. All Rights Reserved\n *\n * Use of this code requires a commercial software license with ForgeRock AS.\n * or with one of its affiliates. All use shall be exclusively subject\n * to such license between the licensee and ForgeRock AS.\n */\n\nvar new Location = foo;',
+        },
+        { name: 'messageType', value: '4' },
+      ],
+    },
+  ],
+};
+
+const securityKeyResponse = `/* * Copyright 2018 ForgeRock AS. All Rights Reserved * * Use of this code requires a commercial software license with ForgeRock AS. * or with one of its affiliates. All use shall be exclusively subject * to such license between the licensee and ForgeRock AS. */ var newLocation = document.getElementById("wrapper"); var oldHtml = newLocation.getElementsByTagName("fieldset")[0].innerHTML; newLocation.getElementsByTagName("fieldset")[0].innerHTML = "<div class=\"panel panel-default\">\n" + " <div class=\"panel-body text-center\">\n" + " <h3>Your Recovery Codes</h3>\n" + " <h4>You must make a copy of these recovery codes. They cannot be displayed again.</h4>\n" + " </div>\n" + "<div class=\"text-center\">\n" + "kw50qtmm32\n" + "</div>\n" + "<div class=\"text-center\">\n" + "Rt2Td8AK2s\n" + "</div>\n" + "<div class=\"text-center\">\n" + "6vZrIRCBJB\n" + "</div>\n" + "<div class=\"text-center\">\n" + "HCmL01Yiyv\n" + "</div>\n" + "<div class=\"text-center\">\n" + "BvDsSpazA2\n" + "</div>\n" + "<div class=\"text-center\">\n" + "T6pbKLyW2l\n" + "</div>\n" + "<div class=\"text-center\">\n" + "gZR0u6XubS\n" + "</div>\n" + "<div class=\"text-center\">\n" + "VZ1bH94IfO\n" + "</div>\n" + "<div class=\"text-center\">\n" + "O9BZ4bLefQ\n" + "</div>\n" + "<div class=\"text-center\">\n" + "NKNrBxlHCt\n" + "</div>\n" + "<div class=\"panel-body text-center\">\n" + " <p>Use one of these codes to authenticate if you lose your device, which has been named: <em>New Security Key</em></p>\n" + "</div>\n" + "</div>" + oldHtml; document.body.appendChild(newLocation);`;
+const securityKeyCustomNameResponse = `/* * Copyright 2018 ForgeRock AS. All Rights Reserved * * Use of this code requires a commercial software license with ForgeRock AS. * or with one of its affiliates. All use shall be exclusively subject * to such license between the licensee and ForgeRock AS. */ var newLocation = document.getElementById("wrapper"); var oldHtml = newLocation.getElementsByTagName("fieldset")[0].innerHTML; newLocation.getElementsByTagName("fieldset")[0].innerHTML = "<div class=\"panel panel-default\">\n" + " <div class=\"panel-body text-center\">\n" + " <h3>Your Recovery Codes</h3>\n" + " <h4>You must make a copy of these recovery codes. They cannot be displayed again.</h4>\n" + " </div>\n" + "<div class=\"text-center\">\n" + "kw50qtmm32\n" + "</div>\n" + "<div class=\"text-center\">\n" + "Rt2Td8AK2s\n" + "</div>\n" + "<div class=\"text-center\">\n" + "6vZrIRCBJB\n" + "</div>\n" + "<div class=\"text-center\">\n" + "HCmL01Yiyv\n" + "</div>\n" + "<div class=\"text-center\">\n" + "BvDsSpazA2\n" + "</div>\n" + "<div class=\"text-center\">\n" + "T6pbKLyW2l\n" + "</div>\n" + "<div class=\"text-center\">\n" + "gZR0u6XubS\n" + "</div>\n" + "<div class=\"text-center\">\n" + "VZ1bH94IfO\n" + "</div>\n" + "<div class=\"text-center\">\n" + "O9BZ4bLefQ\n" + "</div>\n" + "<div class=\"text-center\">\n" + "NKNrBxlHCt\n" + "</div>\n" + "<div class=\"panel-body text-center\">\n" + " <p>Use one of these codes to authenticate if you lose your device, which has been named: <em>My Custom Device Name</em></p>\n" + "</div>\n" + "</div>" + oldHtml; document.body.appendChild(newLocation);`;
+
+export {
+  displayRecoveryCodes,
+  displayRecoveryCodesResponse,
+  expectedDeviceName,
+  expectedRecoveryCodes,
+  otherResponse,
+  securityKeyCustomNameResponse,
+  securityKeyResponse,
+};

package/src/lib/step.test.ts

@@ -0,0 +1,104 @@
+/*
+ * 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 { callbackType } from '@forgerock/sdk-types';
+import { describe, it, expect } from 'vitest';
+
+import type { Step } from '@forgerock/sdk-types';
+
+import { createJourneyStep } from './step.utils.js';
+import { NameCallback } from './callbacks/name-callback.js';
+
+describe('fr-step.ts', () => {
+  const stepPayload: Step = {
+    authId: '123',
+    callbacks: [
+      {
+        type: callbackType.NameCallback,
+        input: [{ name: 'IDToken1', value: '' }],
+        output: [{ name: 'prompt', value: 'Username' }],
+      },
+      {
+        type: callbackType.PasswordCallback,
+        input: [{ name: 'IDToken2', value: '' }],
+        output: [{ name: 'prompt', value: 'Password' }],
+      },
+      {
+        type: callbackType.NameCallback, // Duplicate for testing
+        input: [{ name: 'IDToken3', value: '' }],
+        output: [{ name: 'prompt', value: 'Username 2' }],
+      },
+    ],
+    description: 'Step description',
+    header: 'Step header',
+    stage: 'Step stage',
+  };
+
+  it('should correctly initialize with a payload', () => {
+    const step = createJourneyStep(stepPayload);
+    expect(step.payload).toEqual(stepPayload);
+    expect(step.callbacks).toHaveLength(3);
+    expect(step.callbacks[0]).toBeInstanceOf(NameCallback);
+  });
+
+  it('should get a single callback of a specific type', () => {
+    const singleCallbackPayload: Step = { ...stepPayload, callbacks: [stepPayload.callbacks![1]] };
+    const step = createJourneyStep(singleCallbackPayload);
+    const cb = step.getCallbackOfType(callbackType.PasswordCallback);
+    expect(cb).toBeDefined();
+    expect(cb.getType()).toBe(callbackType.PasswordCallback);
+  });
+
+  it('should throw an error if getCallbackOfType finds no matching callbacks', () => {
+    const step = createJourneyStep(stepPayload);
+    const err = `Expected 1 callback of type "TermsAndConditionsCallback", but found 0`;
+    expect(() => step.getCallbackOfType(callbackType.TermsAndConditionsCallback)).toThrow(err);
+  });
+
+  it('should throw an error if getCallbackOfType finds multiple matching callbacks', () => {
+    const step = createJourneyStep(stepPayload);
+    const err = `Expected 1 callback of type "NameCallback", but found 2`;
+    expect(() => step.getCallbackOfType(callbackType.NameCallback)).toThrow(err);
+  });
+
+  it('should get all callbacks of a specific type', () => {
+    const step = createJourneyStep(stepPayload);
+    const callbacks = step.getCallbacksOfType(callbackType.NameCallback);
+    expect(callbacks).toHaveLength(2);
+    expect(callbacks[0].getType()).toBe(callbackType.NameCallback);
+    expect(callbacks[1].getType()).toBe(callbackType.NameCallback);
+  });
+
+  it('should return an empty array if getCallbacksOfType finds no matches', () => {
+    const step = createJourneyStep(stepPayload);
+    const callbacks = step.getCallbacksOfType(callbackType.TermsAndConditionsCallback);
+    expect(callbacks).toHaveLength(0);
+  });
+
+  it('should set the value of a specific callback', () => {
+    const singleCallbackPayload: Step = { ...stepPayload, callbacks: [stepPayload.callbacks![1]] };
+    const step = createJourneyStep(singleCallbackPayload);
+    step.setCallbackValue(callbackType.PasswordCallback, 'password123');
+    const cb = step.getCallbackOfType(callbackType.PasswordCallback);
+    expect(cb.getInputValue()).toBe('password123');
+  });
+
+  it('should return the description', () => {
+    const step = createJourneyStep(stepPayload);
+    expect(step.getDescription()).toBe('Step description');
+  });
+
+  it('should return the header', () => {
+    const step = createJourneyStep(stepPayload);
+    expect(step.getHeader()).toBe('Step header');
+  });
+
+  it('should return the stage', () => {
+    const step = createJourneyStep(stepPayload);
+    expect(step.getStage()).toBe('Step stage');
+  });
+});

package/src/lib/step.types.ts

@@ -0,0 +1,22 @@
+/*
+ * 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 type { AuthResponse, CallbackType, Step, StepType } from '@forgerock/sdk-types';
+
+import type { BaseCallback } from './callbacks/base-callback.js';
+
+export type JourneyStep = AuthResponse & {
+  type: StepType.Step;
+  payload: Step;
+  callbacks: BaseCallback[];
+  getCallbackOfType: <T extends BaseCallback>(type: CallbackType) => T;
+  getCallbacksOfType: <T extends BaseCallback>(type: CallbackType) => T[];
+  setCallbackValue: (type: CallbackType, value: unknown) => void;
+  getDescription: () => string | undefined;
+  getHeader: () => string | undefined;
+  getStage: () => string | undefined;
+};

package/src/lib/step.utils.ts

@@ -0,0 +1,99 @@
+/*
+ * 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 { type CallbackType, type Callback, type Step } from '@forgerock/sdk-types';
+
+import { StepType } from '@forgerock/sdk-types';
+
+import { createCallback } from './callbacks/factory.js';
+
+import type { BaseCallback } from './callbacks/base-callback.js';
+import type { JourneyStep } from './step.types.js';
+import type { CallbackFactory } from './callbacks/factory.js';
+
+function getCallbacksOfType<T extends BaseCallback>(
+  callbacks: BaseCallback[],
+  type: CallbackType,
+): T[] {
+  return callbacks.filter((x) => x.getType() === type) as T[];
+}
+
+function getCallbackOfType<T extends BaseCallback>(
+  callbacks: BaseCallback[],
+  type: CallbackType,
+): T {
+  const callbacksOfType = getCallbacksOfType<T>(callbacks, type);
+  if (callbacksOfType.length !== 1) {
+    throw new Error(`Expected 1 callback of type "${type}", but found ${callbacksOfType.length}`);
+  }
+  return callbacksOfType[0];
+}
+
+function setCallbackValue(callbacks: BaseCallback[], type: CallbackType, value: unknown): void {
+  const callbacksToUpdate = getCallbacksOfType(callbacks, type);
+  if (callbacksToUpdate.length !== 1) {
+    throw new Error(`Expected 1 callback of type "${type}", but found ${callbacksToUpdate.length}`);
+  }
+  callbacksToUpdate[0].setInputValue(value);
+}
+
+function getDescription(payload: Step): string | undefined {
+  return payload.description;
+}
+
+function getHeader(payload: Step): string | undefined {
+  return payload.header;
+}
+
+function getStage(payload: Step): string | undefined {
+  return payload.stage;
+}
+
+function convertCallbacks(
+  callbacks: Callback[],
+  callbackFactory?: CallbackFactory,
+): BaseCallback[] {
+  const converted = callbacks.map((x: Callback) => {
+    // This gives preference to the provided factory and falls back to our default implementation
+    return (callbackFactory || createCallback)(x) || createCallback(x);
+  });
+  return converted;
+}
+
+function createJourneyStep(payload: Step, callbackFactory?: CallbackFactory): JourneyStep {
+  // Redux Toolkit freezes data, so we need to clone it before making any changes
+  const unfrozenPayload =
+    typeof structuredClone === 'function'
+      ? structuredClone(payload)
+      : (JSON.parse(JSON.stringify(payload)) as Step);
+
+  const convertedCallbacks = unfrozenPayload.callbacks
+    ? convertCallbacks(unfrozenPayload.callbacks, callbackFactory)
+    : [];
+  return {
+    payload: unfrozenPayload,
+    callbacks: convertedCallbacks,
+    type: StepType.Step,
+    getCallbackOfType: <T extends BaseCallback>(type: CallbackType) =>
+      getCallbackOfType<T>(convertedCallbacks, type),
+    getCallbacksOfType: <T extends BaseCallback>(type: CallbackType) =>
+      getCallbacksOfType<T>(convertedCallbacks, type),
+    setCallbackValue: (type: CallbackType, value: unknown) =>
+      setCallbackValue(convertedCallbacks, type, value),
+    getDescription: () => getDescription(payload),
+    getHeader: () => getHeader(payload),
+    getStage: () => getStage(payload),
+  };
+}
+
+/**
+ * A function that can populate the provided authentication tree step.
+ */
+
+type JourneyStepHandler = (step: JourneyStep) => void;
+
+export { createJourneyStep, JourneyStep, JourneyStepHandler };

package/src/lib/webauthn/enums.ts

@@ -0,0 +1,36 @@
+/*
+ * @forgerock/ping-javascript-sdk
+ *
+ * enums.ts
+ *
+ * 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.
+ */
+
+enum WebAuthnOutcome {
+  Error = 'ERROR',
+  Unsupported = 'unsupported',
+}
+
+enum WebAuthnOutcomeType {
+  AbortError = 'AbortError',
+  DataError = 'DataError',
+  ConstraintError = 'ConstraintError',
+  EncodingError = 'EncodingError',
+  InvalidError = 'InvalidError',
+  NetworkError = 'NetworkError',
+  NotAllowedError = 'NotAllowedError',
+  NotSupportedError = 'NotSupportedError',
+  SecurityError = 'SecurityError',
+  TimeoutError = 'TimeoutError',
+  UnknownError = 'UnknownError',
+}
+
+enum WebAuthnStepType {
+  None = 0,
+  Authentication = 1,
+  Registration = 2,
+}
+
+export { WebAuthnOutcome, WebAuthnOutcomeType, WebAuthnStepType };

package/src/lib/webauthn/helpers.mock.data.ts

@@ -0,0 +1,24 @@
+/*
+ * @forgerock/ping-javascript-sdk
+ *
+ * helpers.mock.data.ts
+ *
+ * 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.
+ */
+
+export const allowCredentials70 =
+  'allowCredentials: [{ "type": "public-key", "id": new Int8Array([1, -16, 9, 79, 6, -2, -82, 51, 124, -94, 95, 23, -86, 70, -43, 89, 91, -9, 45, -22, 91, -51, 84, 93, 24, -64, 38, 101, 126, -53, 87, 70, -49, -88, -105, 116, 33, 75, -39, -92, -5, 115, 12, 52, 124, -100, 85, 104, -15, 5, -13, 25, -74, 101, 71, -115, -102, 16, 10, -9, -19, -110, 65, 118, -28, 89, -15, -115, -81, 22, -104, 123, 17, -92, 49, 109, -38, -51, 100, 96, -65, 25, -48, 28, 106, -45, 17, -45, -37, 46, -5, -6, -26, -23, -108, 13, -66, -55, -117, -107, 119, 7, -32, 34, 46, 0, -29, -111, -32, 45, -15, -113, 110, 123, -44, 6, 10, 65, 99, 25, 105, 69, -127, 76, 127, -33, -89, -56, 74, 25, 43, -43, -56, 9, 87, 80, 124, -32, -39, 115, 17, 18, 78, 121, 69, -36, -44, -28, -109, -126, 58, 64, 80, -4, 21, 63, -19]).buffer }]';
+
+export const allowMultipleCredentials70 =
+  'allowCredentials: [{ "type": "public-key", "id": new Int8Array([-33, 120, 18, 124, 16, 5, -127, -51, 68, 85, 76, -92, -3, 25, 116, 91, 71, 53, 106, -114, -86, 9, -81, -96, -32, -110, 66, -23, -5, 104, 96, 46, 43, -66, -110, 8, -70, 11, 51, -93, 19, 124, 81, 78, 58, -97, 89, -87, -26, -112, 95, -83, 118, -25, 118, 3, 35, -96, 120, -76, -87, 83, -101, 82]).buffer },{ "type": "public-key", "id": new Int8Array([1, 73, 82, 23, 76, -5, -53, -48, -104, -17, -42, 45, 7, 35, 35, -72, -7, 37, 9, 37, 117, 42, 66, 116, 58, 25, -68, 53, 113, -10, 102, 3, -60, -81, -74, 96, -5, 111, -56, 110, -101, -54, -31, -123, -100, 3, 37, -69, -114, -19, -25, -62, 18, 122, 39, 11, 83, 60, -58, 3, 116, 10, -80, -35, 6, -128, -51, -92, 100, -115, -22, -122, 21, -65, 97, 67, -49, 26, 42, -11, 90, 121, -63, 112, -16, 118, -99, -73, -89, -67, 72, -80, 18, -72, 109, 4, -14, 1, -93, 17, -17, -70, -2, -5, -116, 111, -128, 7, 62, -34, -43, 110, 89, 113, -65, -95, 113, -5, -104, -100, -73, 42, 2, 112, -21, 41, 41, 91, 108, -102, 47, -77, -52, 70, 107, -4, 25, -120, 114, 30, 23, 103, 120, 17, 55, 91, -110, -58, -110, 13, -56, 57, -126, 36, 40, 89, -9]).buffer }]';
+
+export const acceptableCredentials653 =
+  '{ "type": "public-key", "id": new Int8Array([53, -21, 26, -99, 5, 4, -112, -76, -126, 90, -35, -7, -31, -92, 19, -71, -39, 73, 52, -10, -14, -7, -59, -7, -36, -111, 64, 101, 29, 89, 90, -56, 108, 42, 32, -19, -113, 118, -114, 49, 109, -70, 68, -89, 36, -36, -103, -128, 34, -24, -40, -71, -125, -120, -80, 63, 25, -33, 2, 26, 111, -52, -15, -52]).buffer }';
+
+export const acceptableMultipleCredentials653 =
+  '{ "type": "public-key", "id": new Int8Array([17, 88, -12, 26, -50, -48, -38, 36, -69, -105, -68, -38, 66, -53, -37, -50, -109, -126, 122, 26, 25, -45, 96, 37, -124, 102, 124, 94, -98, -59, 113, 94, 115, -111, -69, 45, 37, -83, 118, -115, -4, -49, 34, 115, -24, -49, -37, -17, -127, -15, 62, 18, 93, 122, -109, 53, -52, 44, -63, -74, 109, 2, -110, 45]).buffer },{ "type": "public-key", "id": new Int8Array([1, 83, -98, 32, 110, -62, 78, 53, -63, -118, 12, 122, -72, -15, 85, 48, -39, -97, -73, 108, -122, -60, 56, -112, -89, -118, 111, 0, -4, 13, -50, -43, -53, 28, 114, 82, 22, -76, 15, 51, -95, 26, -90, -93, -51, 115, -28, 85, -105, -27, 111, 70, 106, -28, 45, 126, 44, 63, -16, 97, -55, 31, -24, 57, -92, 48, 26, 127, -39, 75, 12, 13, 100, -77, 13, -48, 49, 52, 31, 85, 9, 63, -122, -90, -54, -87, -110, -1, 115, -122, -69, -15, 83, 57, 95, -31, -92, -116, 89, -109, -98, 21, 24, -80, -28, 103, -28, -82, -39, 114, -29, -46, -76, 123, -69, -44, 124, 10, 53, -103, 19, -43, -12, 62, -83, -86, 95, -78, 70, -105, 116, -25, 106, 54, -72, -119, 91, 91, -71, -49, 22, 25, -108, 112, -14, 55, 9, 75, 89, -91, -59, 45]).buffer }';
+
+export const pubKeyCredParamsStr =
+  '[ { "type": "public-key", "alg": -257 }, { "type": "public-key", "alg": -7 } ]';