@forgerock/journey-client 0.0.0-beta-20251222204813

package/src/lib/callbacks/suspended-text-output-callback.test.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 { Callback } from '@forgerock/sdk-types';
+
+import { SuspendedTextOutputCallback } from './suspended-text-output-callback.js';
+
+describe('SuspendedTextOutputCallback', () => {
+  it('should instantiate correctly and inherit from TextOutputCallback', () => {
+    const payload: Callback = {
+      type: callbackType.SuspendedTextOutputCallback,
+      output: [
+        {
+          name: 'message',
+          value: 'Suspended message',
+        },
+        {
+          name: 'messageType',
+          value: '0',
+        },
+      ],
+      input: [],
+    };
+    const cb = new SuspendedTextOutputCallback(payload);
+    expect(cb.getMessage()).toBe('Suspended message');
+    expect(cb.getMessageType()).toBe('0');
+  });
+});

package/src/lib/callbacks/suspended-text-output-callback.ts

@@ -0,0 +1,21 @@
+/*
+ * 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 { Callback } from '@forgerock/sdk-types';
+
+import { TextOutputCallback } from './text-output-callback.js';
+
+/**
+ * Represents a callback used to display a message.
+ */
+export class SuspendedTextOutputCallback extends TextOutputCallback {
+  /**
+   * @param payload The raw payload returned by OpenAM
+   */
+  constructor(public override payload: Callback) {
+    super(payload);
+  }
+}

package/src/lib/callbacks/terms-and-conditions-callback.test.ts

@@ -0,0 +1,55 @@
+/*
+ * 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 { Callback } from '@forgerock/sdk-types';
+
+import { TermsAndConditionsCallback } from './terms-and-conditions-callback.js';
+
+describe('TermsAndConditionsCallback', () => {
+  const date = new Date().toString();
+  const payload: Callback = {
+    type: callbackType.TermsAndConditionsCallback,
+    output: [
+      {
+        name: 'terms',
+        value: 'Lorem ipsum...',
+      },
+      {
+        name: 'version',
+        value: '1.0',
+      },
+      {
+        name: 'createDate',
+        value: date,
+      },
+    ],
+    input: [
+      {
+        name: 'IDToken1',
+        value: false,
+      },
+    ],
+  };
+
+  it('should allow getting terms, version, and date', () => {
+    const cb = new TermsAndConditionsCallback(payload);
+    expect(cb.getTerms()).toBe('Lorem ipsum...');
+    expect(cb.getVersion()).toBe('1.0');
+    expect(cb.getCreateDate()).toEqual(new Date(date));
+  });
+
+  it('should allow setting acceptance', () => {
+    const cb = new TermsAndConditionsCallback(payload);
+    cb.setAccepted(true);
+    expect(cb.getInputValue()).toBe(true);
+    cb.setAccepted(false);
+    expect(cb.getInputValue()).toBe(false);
+  });
+});

package/src/lib/callbacks/terms-and-conditions-callback.ts

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

package/src/lib/callbacks/text-input-callback.test.ts

@@ -0,0 +1,43 @@
+/*
+ * @forgerock/ping-javascript-sdk
+ *
+ * attribute-input-callback.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 { callbackType } from '@forgerock/sdk-types';
+
+import type { Callback } from '@forgerock/sdk-types';
+
+import { TextInputCallback } from './text-input-callback.js';
+
+describe('TextInputCallback', () => {
+  const payload: Callback = {
+    type: callbackType.TextInputCallback,
+    output: [
+      {
+        name: 'prompt',
+        value: 'Provide a nickname for this account',
+      },
+    ],
+    input: [
+      {
+        name: 'IDToken1',
+        value: '',
+      },
+    ],
+  };
+
+  it('reads/writes basic properties', () => {
+    const cb = new TextInputCallback(payload);
+
+    expect(cb.getPrompt()).toBe('Provide a nickname for this account');
+
+    cb.setInput('Test setting input');
+
+    expect(cb.getInputValue()).toBe('Test setting input');
+  });
+});

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

@@ -0,0 +1,35 @@
+/*
+ * 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 type { Callback } from '@forgerock/sdk-types';
+
+import { BaseCallback } from './base-callback.js';
+
+/**
+ * Represents a callback used to retrieve input from the user.
+ */
+export class TextInputCallback extends BaseCallback {
+  /**
+   * @param payload The raw payload returned by OpenAM
+   */
+  constructor(public override payload: Callback) {
+    super(payload);
+  }
+
+  /**
+   * Gets the callback's prompt.
+   */
+  public getPrompt(): string {
+    return this.getOutputByName<string>('prompt', '');
+  }
+
+  /**
+   * Sets the callback's input value.
+   */
+  public setInput(input: string): void {
+    this.setInputValue(input);
+  }
+}

package/src/lib/callbacks/text-output-callback.test.ts

@@ -0,0 +1,36 @@
+/*
+ * 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 { Callback } from '@forgerock/sdk-types';
+
+import { TextOutputCallback } from './text-output-callback.js';
+
+describe('TextOutputCallback', () => {
+  const payload: Callback = {
+    type: callbackType.TextOutputCallback,
+    output: [
+      {
+        name: 'message',
+        value: 'This is a message',
+      },
+      {
+        name: 'messageType',
+        value: '0',
+      },
+    ],
+    input: [],
+  };
+
+  it('should allow getting the message and message type', () => {
+    const cb = new TextOutputCallback(payload);
+    expect(cb.getMessage()).toBe('This is a message');
+    expect(cb.getMessageType()).toBe('0');
+  });
+});

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

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

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

@@ -0,0 +1,84 @@
+/*
+ * @forgerock/ping-javascript-sdk
+ *
+ * validated-create-password-callback.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 { callbackType } from '@forgerock/sdk-types';
+
+import type { Callback } from '@forgerock/sdk-types';
+
+import { ValidatedCreatePasswordCallback } from './validated-create-password-callback.js';
+
+describe('ValidatedCreatePasswordCallback', () => {
+  const payload: Callback = {
+    type: callbackType.ValidatedCreatePasswordCallback,
+    output: [
+      {
+        name: 'echoOn',
+        value: false,
+      },
+      {
+        name: 'required',
+        value: true,
+      },
+      {
+        name: 'policies',
+        value: {
+          policyRequirements: ['a', 'b'],
+          name: 'password',
+          policies: [],
+        },
+      },
+      {
+        name: 'failedPolicies',
+        value: [JSON.stringify({ failedPolicies: { c: 'c', d: 'd' } })],
+      },
+      {
+        name: 'validateOnly',
+        value: false,
+      },
+      {
+        name: 'prompt',
+        value: 'Password',
+      },
+    ],
+    input: [
+      {
+        name: 'IDToken2',
+        value: '',
+      },
+      {
+        name: 'IDToken2validateOnly',
+        value: false,
+      },
+    ],
+    _id: 1,
+  };
+
+  it('reads/writes basic properties with "validate only"', () => {
+    const cb = new ValidatedCreatePasswordCallback(payload);
+    cb.setPassword('abcd123');
+    cb.setValidateOnly(true);
+
+    expect(cb.getType()).toBe('ValidatedCreatePasswordCallback');
+    expect(cb.getPrompt()).toBe('Password');
+    expect(cb.isRequired()).toBe(true);
+    expect(cb.getPolicies().policyRequirements).toStrictEqual(['a', 'b']);
+    expect(cb.getFailedPolicies()).toStrictEqual([{ failedPolicies: { c: 'c', d: 'd' } }]);
+    if (!cb.payload.input) throw new Error('Input is not defined');
+    expect(cb.payload.input[0].value).toBe('abcd123');
+    expect(cb.payload.input[1].value).toBe(true);
+  });
+
+  it('writes validate only to `false` for submission', () => {
+    const cb = new ValidatedCreatePasswordCallback(payload);
+    cb.setValidateOnly(false);
+    if (!cb.payload.input) throw new Error('Input is not defined');
+    expect(cb.payload.input[1].value).toBe(false);
+  });
+});

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

@@ -0,0 +1,75 @@
+/*
+ * 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 { Callback, PolicyRequirement } from '@forgerock/sdk-types';
+
+import { BaseCallback } from './base-callback.js';
+
+/**
+ * Represents a callback used to collect a valid platform password.
+ */
+export class ValidatedCreatePasswordCallback extends BaseCallback {
+  /**
+   * @param payload The raw payload returned by OpenAM
+   */
+  constructor(public override payload: Callback) {
+    super(payload);
+  }
+
+  /**
+   * Gets the callback's failed policies.
+   */
+  public getFailedPolicies(): PolicyRequirement[] {
+    const failedPolicies = this.getOutputByName<PolicyRequirement[]>(
+      'failedPolicies',
+      [],
+    ) as unknown as string[];
+    try {
+      return failedPolicies.map((v) => JSON.parse(v)) as PolicyRequirement[];
+    } 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
+  public getPolicies(): Record<string, any> {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return this.getOutputByName<Record<string, any>>('policies', {});
+  }
+
+  /**
+   * Gets the callback's prompt.
+   */
+  public getPrompt(): string {
+    return this.getOutputByName<string>('prompt', '');
+  }
+
+  /**
+   * Gets whether the password is required.
+   */
+  public isRequired(): boolean {
+    return this.getOutputByName<boolean>('required', false);
+  }
+
+  /**
+   * Sets the callback's password.
+   */
+  public setPassword(password: string): void {
+    this.setInputValue(password);
+  }
+
+  /**
+   * Set if validating value only.
+   */
+  public setValidateOnly(value: boolean): void {
+    this.setInputValue(value, /validateOnly/);
+  }
+}

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

@@ -0,0 +1,84 @@
+/*
+ * @forgerock/ping-javascript-sdk
+ *
+ * validated-create-username-callback.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 { callbackType } from '@forgerock/sdk-types';
+
+import type { Callback } from '@forgerock/sdk-types';
+
+import { ValidatedCreateUsernameCallback } from './validated-create-username-callback.js';
+
+describe('ValidatedCreateUsernameCallback', () => {
+  const payload: Callback = {
+    type: callbackType.ValidatedCreateUsernameCallback,
+    output: [
+      {
+        name: 'echoOn',
+        value: false,
+      },
+      {
+        name: 'required',
+        value: true,
+      },
+      {
+        name: 'policies',
+        value: {
+          policyRequirements: ['a', 'b'],
+          name: 'username',
+          policies: [],
+        },
+      },
+      {
+        name: 'failedPolicies',
+        value: [JSON.stringify({ failedPolicies: { c: 'c', d: 'd' } })],
+      },
+      {
+        name: 'validateOnly',
+        value: false,
+      },
+      {
+        name: 'prompt',
+        value: 'Username',
+      },
+    ],
+    input: [
+      {
+        name: 'IDToken2',
+        value: '',
+      },
+      {
+        name: 'IDToken2validateOnly',
+        value: false,
+      },
+    ],
+    _id: 1,
+  };
+
+  it('reads/writes basic properties with "validate only"', () => {
+    const cb = new ValidatedCreateUsernameCallback(payload);
+    cb.setName('abcd123');
+    cb.setValidateOnly(true);
+
+    expect(cb.getType()).toBe('ValidatedCreateUsernameCallback');
+    expect(cb.getPrompt()).toBe('Username');
+    expect(cb.isRequired()).toBe(true);
+    expect(cb.getPolicies().policyRequirements).toStrictEqual(['a', 'b']);
+    expect(cb.getFailedPolicies()).toStrictEqual([{ failedPolicies: { c: 'c', d: 'd' } }]);
+    if (!cb.payload.input) throw new Error('Input is not defined');
+    expect(cb.payload.input[0].value).toBe('abcd123');
+    expect(cb.payload.input[1].value).toBe(true);
+  });
+
+  it('writes validate only to `false` for submission', () => {
+    const cb = new ValidatedCreateUsernameCallback(payload);
+    cb.setValidateOnly(false);
+    if (!cb.payload.input) throw new Error('Input is not defined');
+    expect(cb.payload.input[1].value).toBe(false);
+  });
+});

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

@@ -0,0 +1,76 @@
+/*
+ * 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 type { Callback, PolicyRequirement } from '@forgerock/sdk-types';
+
+import { BaseCallback } from './base-callback.js';
+
+/**
+ * Represents a callback used to collect a valid platform username.
+ */
+export class ValidatedCreateUsernameCallback extends BaseCallback {
+  /**
+   * @param payload The raw payload returned by OpenAM
+   */
+  constructor(public override payload: Callback) {
+    super(payload);
+  }
+
+  /**
+   * Gets the callback's prompt.
+   */
+  public getPrompt(): string {
+    return this.getOutputByName<string>('prompt', '');
+  }
+
+  /**
+   * Gets the callback's failed policies.
+   */
+  public getFailedPolicies(): PolicyRequirement[] {
+    const failedPolicies = this.getOutputByName<PolicyRequirement[]>(
+      'failedPolicies',
+      [],
+    ) as unknown as string[];
+    try {
+      return failedPolicies.map((v) => JSON.parse(v)) as PolicyRequirement[];
+    } 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
+  public getPolicies(): Record<string, any> {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return this.getOutputByName<Record<string, any>>('policies', {});
+  }
+
+  /**
+   * Gets whether the username is required.
+   */
+  public isRequired(): boolean {
+    return this.getOutputByName<boolean>('required', false);
+  }
+
+  /**
+   * Sets the callback's username.
+   */
+  public setName(name: string): void {
+    this.setInputValue(name);
+  }
+
+  /**
+   * Set if validating value only.
+   */
+  public setValidateOnly(value: boolean): void {
+    this.setInputValue(value, /validateOnly/);
+  }
+}