@forgerock/journey-client 0.0.0-beta-20251222204813

package/src/lib/callbacks/ping-protect-initialize-callback.test.ts

@@ -0,0 +1,153 @@
+/*
+ * @forgerock/ping-javascript-sdk
+ *
+ * ping-protect-intitialize-callback.test.ts
+ *
+ * Copyright (c) 2024 - 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 { vi, describe, expect, it } from 'vitest';
+
+import { PingOneProtectInitializeCallback } from './ping-protect-initialize-callback.js';
+
+describe('PingOneProtectInitializeCallback', () => {
+  it('should exist', () => {
+    expect(PingOneProtectInitializeCallback).toBeDefined();
+  });
+  it('should test the getConfig method', () => {
+    const callback = new PingOneProtectInitializeCallback({
+      type: callbackType.PingOneProtectInitializeCallback,
+      input: [
+        {
+          name: 'IDToken1signals',
+          value: '',
+        },
+        {
+          name: 'IDToken1clientError',
+          value: '',
+        },
+      ],
+      output: [
+        {
+          name: 'envId',
+          value: '02fb4743-189a-4bc7-9d6c-a919edfe6447',
+        },
+        {
+          name: 'consoleLogEnabled',
+          value: false,
+        },
+        {
+          name: 'deviceAttributesToIgnore',
+          value: [],
+        },
+        {
+          name: 'customHost',
+          value: '',
+        },
+        {
+          name: 'lazyMetadata',
+          value: false,
+        },
+        {
+          name: 'behavioralDataCollection',
+          value: true,
+        },
+        {
+          name: 'deviceKeyRsyncIntervals',
+          value: 14,
+        },
+        {
+          name: 'enableTrust',
+          value: false,
+        },
+        {
+          name: 'disableTags',
+          value: false,
+        },
+        {
+          name: 'disableHub',
+          value: false,
+        },
+      ],
+    });
+    const mock = vi.spyOn(callback, 'getConfig');
+    const config = callback.getConfig();
+    expect(mock).toHaveBeenCalled();
+    expect(config).toMatchObject({
+      envId: '02fb4743-189a-4bc7-9d6c-a919edfe6447',
+      consoleLogEnabled: false,
+      deviceAttributesToIgnore: [],
+      customHost: '',
+      lazyMetadata: false,
+      behavioralDataCollection: true,
+      deviceKeyRsyncIntervals: 14,
+      enableTrust: false,
+      disableTags: false,
+      disableHub: false,
+    });
+  });
+  it('should test the setClientError method', () => {
+    const callback = new PingOneProtectInitializeCallback({
+      type: callbackType.PingOneProtectInitializeCallback,
+      input: [
+        {
+          name: 'IDToken1signals',
+          value: '',
+        },
+        {
+          name: 'IDToken1clientError',
+          value: '',
+        },
+      ],
+      output: [
+        {
+          name: 'envId',
+          value: '02fb4743-189a-4bc7-9d6c-a919edfe6447',
+        },
+        {
+          name: 'consoleLogEnabled',
+          value: false,
+        },
+        {
+          name: 'deviceAttributesToIgnore',
+          value: [],
+        },
+        {
+          name: 'customHost',
+          value: '',
+        },
+        {
+          name: 'lazyMetadata',
+          value: false,
+        },
+        {
+          name: 'behavioralDataCollection',
+          value: true,
+        },
+        {
+          name: 'deviceKeyRsyncIntervals',
+          value: 14,
+        },
+        {
+          name: 'enableTrust',
+          value: false,
+        },
+        {
+          name: 'disableTags',
+          value: false,
+        },
+        {
+          name: 'disableHub',
+          value: false,
+        },
+      ],
+    });
+    const mock = vi.spyOn(callback, 'setClientError');
+    callback.setClientError('error i just set');
+    expect(mock).toHaveBeenCalled();
+    expect(callback.getInputValue('IDToken1clientError')).toBe('error i just set');
+  });
+});

package/src/lib/callbacks/ping-protect-initialize-callback.ts

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2024 - 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';
+
+/**
+ * @class - Represents a callback used to initialize and start device and behavioral data collection.
+ */
+export class PingOneProtectInitializeCallback extends BaseCallback {
+  /**
+   * @param payload The raw payload returned by OpenAM
+   */
+  constructor(public override payload: Callback) {
+    super(payload);
+  }
+
+  /**
+   * Get callback's initialization config settings
+   */
+  public getConfig() {
+    const config = {
+      envId: this.getOutputByName<string>('envId', ''),
+      consoleLogEnabled: this.getOutputByName<boolean>('consoleLogEnabled', false),
+      deviceAttributesToIgnore: this.getOutputByName<string[]>('deviceAttributesToIgnore', []),
+      customHost: this.getOutputByName<string>('customHost', ''),
+      lazyMetadata: this.getOutputByName<boolean>('lazyMetadata', false),
+      behavioralDataCollection: this.getOutputByName<boolean>('behavioralDataCollection', true),
+      deviceKeyRsyncIntervals: this.getOutputByName<number>('deviceKeyRsyncIntervals', 14),
+      enableTrust: this.getOutputByName<boolean>('enableTrust', false),
+      disableTags: this.getOutputByName<boolean>('disableTags', false),
+      disableHub: this.getOutputByName<boolean>('disableHub', false),
+    };
+    return config;
+  }
+
+  public setClientError(errorMessage: string): void {
+    this.setInputValue(errorMessage, /clientError/);
+  }
+}

package/src/lib/callbacks/polling-wait-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 { PollingWaitCallback } from './polling-wait-callback.js';
+
+describe('PollingWaitCallback', () => {
+  const payload: Callback = {
+    type: callbackType.PollingWaitCallback,
+    output: [
+      {
+        name: 'message',
+        value: 'Please wait...',
+      },
+      {
+        name: 'waitTime',
+        value: '5000',
+      },
+    ],
+    input: [],
+  };
+
+  it('should allow getting the message and wait time', () => {
+    const cb = new PollingWaitCallback(payload);
+    expect(cb.getMessage()).toBe('Please wait...');
+    expect(cb.getWaitTime()).toBe(5000);
+  });
+});

package/src/lib/callbacks/polling-wait-callback.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 instruct the system to poll while a backend process completes.
+ */
+export class PollingWaitCallback extends BaseCallback {
+  /**
+   * @param payload The raw payload returned by OpenAM
+   */
+  constructor(public override payload: Callback) {
+    super(payload);
+  }
+
+  /**
+   * Gets the message to display while polling.
+   */
+  public getMessage(): string {
+    return this.getOutputByName<string>('message', '');
+  }
+
+  /**
+   * Gets the polling interval in milliseconds.
+   */
+  public getWaitTime(): number {
+    return Number(this.getOutputByName<number>('waitTime', 0));
+  }
+}

package/src/lib/callbacks/recaptcha-callback.test.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 { ReCaptchaCallback } from './recaptcha-callback.js';
+
+describe('ReCaptchaCallback', () => {
+  const payload: Callback = {
+    type: callbackType.ReCaptchaCallback,
+    output: [
+      {
+        name: 'recaptchaSiteKey',
+        value: 'test-site-key',
+      },
+    ],
+    input: [
+      {
+        name: 'IDToken1',
+        value: '',
+      },
+    ],
+  };
+
+  it('should allow getting the site key', () => {
+    const cb = new ReCaptchaCallback(payload);
+    expect(cb.getSiteKey()).toBe('test-site-key');
+  });
+
+  it('should allow setting the result', () => {
+    const cb = new ReCaptchaCallback(payload);
+    cb.setResult('recaptcha-response-token');
+    expect(cb.getInputValue()).toBe('recaptcha-response-token');
+  });
+});

package/src/lib/callbacks/recaptcha-callback.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 integrate reCAPTCHA.
+ */
+export class ReCaptchaCallback extends BaseCallback {
+  /**
+   * @param payload The raw payload returned by OpenAM
+   */
+  constructor(public override payload: Callback) {
+    super(payload);
+  }
+
+  /**
+   * Gets the reCAPTCHA site key.
+   */
+  public getSiteKey(): string {
+    return this.getOutputByName<string>('recaptchaSiteKey', '');
+  }
+
+  /**
+   * Sets the reCAPTCHA result.
+   */
+  public setResult(result: string): void {
+    this.setInputValue(result);
+  }
+}

package/src/lib/callbacks/recaptcha-enterprise-callback.test.ts

@@ -0,0 +1,86 @@
+/*
+ * @forgerock/ping-javascript-sdk
+ *
+ * recaptcha-enterprise-callback.test.ts
+ *
+ * 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, expect, it, beforeAll } from 'vitest';
+
+import type { Callback } from '@forgerock/sdk-types';
+
+import { ReCaptchaEnterpriseCallback } from './recaptcha-enterprise-callback.js';
+
+const recaptchaCallback: Callback = {
+  type: callbackType.ReCaptchaEnterpriseCallback,
+  output: [
+    {
+      name: 'recaptchaSiteKey',
+      value: '6LdSu_spAAAAAKz3UhIy4JYQld2lm_WRt7dEhf9T',
+    },
+    {
+      name: 'captchaApiUri',
+      value: 'https://www.google.com/recaptcha/enterprise.js',
+    },
+    {
+      name: 'captchaDivClass',
+      value: 'g-recaptcha',
+    },
+  ],
+  input: [
+    {
+      name: 'IDToken1token',
+      value: '',
+    },
+    {
+      name: 'IDToken1action',
+      value: '',
+    },
+    {
+      name: 'IDToken1clientError',
+      value: '',
+    },
+    {
+      name: 'IDToken1payload',
+      value: '',
+    },
+  ],
+};
+describe('enterprise recaptcha', () => {
+  let callback: ReCaptchaEnterpriseCallback;
+  beforeAll(() => {
+    callback = new ReCaptchaEnterpriseCallback(recaptchaCallback);
+  });
+  it('should get the site key', () => {
+    const siteKey = callback.getSiteKey();
+    expect(siteKey).toEqual('6LdSu_spAAAAAKz3UhIy4JYQld2lm_WRt7dEhf9T');
+  });
+  it('should get captchaApiUri', () => {
+    const url = callback.getApiUrl();
+    expect(url).toEqual('https://www.google.com/recaptcha/enterprise.js');
+  });
+  it('should set the action', () => {
+    callback.setAction('my_action');
+    expect(callback.getInputValue('IDToken1action')).toEqual('my_action');
+  });
+  it('should set the client error', () => {
+    callback.setClientError('error here');
+    expect(callback.getInputValue('IDToken1clientError')).toEqual('error here');
+  });
+  it('should set the payload', () => {
+    callback.setPayload({ test: 'here' });
+    expect(callback.getInputValue('IDToken1payload')).toEqual({ test: 'here' });
+  });
+  it('should set the token', () => {
+    callback.setResult('12345');
+    expect(callback.getInputValue('IDToken1token')).toEqual('12345');
+  });
+  it('should get the class', () => {
+    const className = callback.getElementClass();
+    expect(className).toBe('g-recaptcha');
+  });
+});

package/src/lib/callbacks/recaptcha-enterprise-callback.ts

@@ -0,0 +1,72 @@
+/*
+ * @forgerock/ping-javascript-sdk
+ *
+ * recaptcha-callback.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 type { Callback } from '@forgerock/sdk-types';
+
+import { BaseCallback } from './base-callback.js';
+
+/**
+ * Represents a callback used to integrate reCAPTCHA.
+ */
+export class ReCaptchaEnterpriseCallback extends BaseCallback {
+  /**
+   * @param payload The raw payload returned by OpenAM
+   */
+  constructor(public override payload: Callback) {
+    super(payload);
+  }
+
+  /**
+   * Gets the reCAPTCHA site key.
+   */
+  public getSiteKey(): string {
+    return this.getOutputByName<string>('recaptchaSiteKey', '');
+  }
+
+  /**
+   * Get the api url
+   */
+  public getApiUrl(): string {
+    return this.getOutputByName<string>('captchaApiUri', '');
+  }
+  /**
+   * Get the class name
+   */
+  public getElementClass(): string {
+    return this.getOutputByName<string>('captchaDivClass', '');
+  }
+  /**
+   * Sets the reCAPTCHA result.
+   */
+  public setResult(result: string): void {
+    this.setInputValue(result);
+  }
+
+  /**
+   * Set client client error
+   */
+  public setClientError(error: string) {
+    this.setInputValue(error, 'IDToken1clientError');
+  }
+
+  /**
+   * Set the recaptcha payload
+   */
+  public setPayload(payload: unknown) {
+    this.setInputValue(payload, 'IDToken1payload');
+  }
+
+  /**
+   * Set the recaptcha action
+   */
+  public setAction(action: string) {
+    this.setInputValue(action, 'IDToken1action');
+  }
+}

package/src/lib/callbacks/redirect-callback.test.ts

@@ -0,0 +1,31 @@
+/*
+ * 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 { RedirectCallback } from './redirect-callback.js';
+
+describe('RedirectCallback', () => {
+  const payload: Callback = {
+    type: callbackType.RedirectCallback,
+    output: [
+      {
+        name: 'redirectUrl',
+        value: 'https://am.example.com/callback?param=value',
+      },
+    ],
+    input: [],
+  };
+
+  it('should allow getting the redirect URL', () => {
+    const cb = new RedirectCallback(payload);
+    expect(cb.getRedirectUrl()).toBe('https://am.example.com/callback?param=value');
+  });
+});

package/src/lib/callbacks/redirect-callback.ts

@@ -0,0 +1,28 @@
+/*
+ * 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 an answer to a choice.
+ */
+export class RedirectCallback extends BaseCallback {
+  /**
+   * @param payload The raw payload returned by OpenAM
+   */
+  constructor(public override payload: Callback) {
+    super(payload);
+  }
+
+  /**
+   * Gets the redirect URL.
+   */
+  public getRedirectUrl(): string {
+    return this.getOutputByName<string>('redirectUrl', '');
+  }
+}

package/src/lib/callbacks/select-idp-callback.test.ts

@@ -0,0 +1,51 @@
+/*
+ * 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 { SelectIdPCallback } from './select-idp-callback.js';
+
+describe('SelectIdPCallback', () => {
+  const payload: Callback = {
+    type: callbackType.SelectIdPCallback,
+    output: [
+      {
+        name: 'providers',
+        value: [
+          { provider: 'google', uiConfig: {} },
+          { provider: 'facebook', uiConfig: {} },
+        ],
+      },
+    ],
+    input: [
+      {
+        name: 'IDToken1',
+        value: '',
+      },
+    ],
+  };
+
+  it('should allow getting the providers', () => {
+    const cb = new SelectIdPCallback(payload);
+    expect(cb.getProviders()).toHaveLength(2);
+    expect(cb.getProviders()[0].provider).toBe('google');
+  });
+
+  it('should allow setting the provider', () => {
+    const cb = new SelectIdPCallback(payload);
+    cb.setProvider('facebook');
+    expect(cb.getInputValue()).toBe('facebook');
+  });
+
+  it('should throw an error for an invalid provider', () => {
+    const cb = new SelectIdPCallback(payload);
+    expect(() => cb.setProvider('twitter')).toThrow('"twitter" is not a valid choice');
+  });
+});

package/src/lib/callbacks/select-idp-callback.ts

@@ -0,0 +1,48 @@
+/*
+ * 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';
+
+interface IdPValue {
+  provider: string;
+  uiConfig: {
+    [key: string]: string;
+  };
+}
+
+/**
+ * Represents a callback used to collect an answer to a choice.
+ */
+export class SelectIdPCallback extends BaseCallback {
+  /**
+   * @param payload The raw payload returned by OpenAM
+   */
+  constructor(public override payload: Callback) {
+    super(payload);
+  }
+
+  /**
+   * Gets the available providers.
+   */
+  public getProviders(): IdPValue[] {
+    return this.getOutputByName<IdPValue[]>('providers', []);
+  }
+
+  /**
+   * Sets the provider by name.
+   */
+  public setProvider(value: string): void {
+    const item = this.getProviders().find((item) => item.provider === value);
+    if (!item) {
+      throw new Error(`"${value}" is not a valid choice`);
+    }
+    this.setInputValue(item.provider);
+  }
+}
+
+export type { IdPValue };